每个接口文档会按照如下格式提供信息:
请求方式:GET/POST(HTTPS)
请求地址:https://oapi.soke.cn/service/sso/gettoken?sso_secret=xxxx
参数说明:
...
返回结果:
...
参数说明:
...
● 请求方式:接口使用的HTTP方法和请求协议。所有接口都使用HTTPS协议。
● 请求地址:接口的请求地址。服务端接口的访问域名分别为:
生产环境:https://oapi.soke.cn
测试环境:https://oapipre.eduto.com
请求参数使用“&”分隔。请求地址中的xxxx是需要替换的变量值。
● 请求参数/参数说明:提供请求参数示例及说明,参数说明包括字段含义、取值范围,开发者在设计数据结构时,应参考该定义范围。
● 返回结果/参数说明:提供返回参数示例及说明。
注意
● 所有接口在调用时都会返回status、message、code。开发者可根据code和message排查问题。
● 请根据status的值是否是ok判断调用是否成功,失败返回error。message是对error的说明,供开发者参考。
● 正常请求会包含requestID字段,问题无法定位时可提供该字段和message由开放平台协助排查。