Postman调用GET /Customers带API key却返回数据仓库文档该如何处理？

基础请求配置校验 #

• 确认请求域名正确：不要误用API文档的访问域名，API接口域名通常为类似api.服务商域名.com的格式，和文档域名docs.服务商域名.com相互独立
• 确认接口路径完全匹配：注意路径大小写敏感，需严格和文档一致写/Customers，不要多写后缀、少写前缀或者拼写错误
• 确认请求方法选择的是GET，不要误选POST、PUT等其他方法

身份认证配置校验 #

API Key的传递方式必须严格符合服务商要求，常见配置有三类，需对照文档确认：

• 放在请求头中：通常参数名为X-API-Key或者遵循Authorization: Apikey 你的密钥的格式，Postman中可以在Authorization选项卡选择「API Key」类型，填写对应参数名和密钥后，选择添加到Header
• 放在URL查询参数中：通常参数名为api_key，需拼接在请求路径后，格式为/Customers?api_key=你的密钥，Postman中可以在Authorization选项卡选择「API Key」类型后，选择添加到Query Params
• 禁止将API Key配置到Basic Auth、OAuth 2.0等错误的认证类型下，否则服务端会识别为未认证，重定向到API文档页

额外配置排查 #

• 关闭Postman的自动重定向功能：在Postman设置中关闭「Automatically follow redirects」，重新发起请求后如果返回301/302状态码，即可确认是服务端因为请求错误将你重定向到了文档页，可以进一步定位问题原因
• 调整Accept请求头：将请求头的Accept值设置为application/json，避免服务端默认返回HTML格式的文档内容

内容的提问来源于stack exchange，提问作者Diganth Sanghvi