Skip to content

API请求指南 ​

必要前提:详细阅读 鉴权 章节,了解如何在请求之前对请求进行进行签名

解密业务的泳道图 ​

这是一张解密业务的泳道图,其中描述解密api的对接时参考的业务逻辑

使用例程进行测试 ​


API应答指南 ​

  • Status Code 本系统的API请求使用了http协议的状态码,在API请求成功时,服务器会返回200 OK 代表API已经执行成功
  • Response Body 每一个API都有其独特的数据body返回的格式,关于数据body的返回请参照您使用的API的文档
  • 在请求出现问题时,本系统会返回非 200 OK 的状态码告知开发者,并且会在body中携带错误信息告知开发者,您可以根据错误信息进行调试与修复(仅限于HTTP/S接口,Websocket接口不支持携带错误信息)
  • 状态码为 4xx 的错误,是由于开发者的使用不当而引起的,比如api接口的签名错误,又或者参数的传递错误。出现此错误请按照API文档详细排查
  • 状态码为 5xx 的错误,是本系统遇到一些无法处理的错误时会出现的错误,您可以重新尝试请求,如果超过10次没有成功,请联系我们处理
  • 出现其他的错误码时,请根据HTTP协议的 Status Code 的规范进行处理,且参考返回的错误信息

本系统由Nikola-LAB强力驱动