调用边缘端OpenAPI时,需要遵循请求规范和响应规范。
边缘端OpenAPI对外提供服务的端口号为9999
。为保证传输安全,所有接口仅支持HTTPS协议。
认证授权
目前支持通过Cookie认证方式访问OpenAPI。开发者必须通过CreateAuthCookie接口获取认证Cookie才能进一步调用其它API。具体步骤如下所示。
响应规范
- 状态码:响应状态码遵循HTTP规范。详细状态码,请参见状态码。
- 响应头:响应头需要包含如下字段默认值。
Server: openresty/1.13.6.2 Date: Thu, 31 Oct 2019 07:51:57 GMT Content-Type: application/json; charset=utf-8 Transfer-Encoding: chunked Connection: keep-alive
- 响应消息体:响应消息体为JSON格式内容,或者为空。
- 当调用API成功时,每个API返回的格式和内容都不同,详情请参见具体API接口文档。
- 当调用API出错时,即响应状态码为非
2**
开头的状态码(例如302
、400
等),响应消息体为错误信息内容,格式如下所示。{ "Code": "string", // What kind of error, such as InvalidParameter. "Message": "string" // Detailed description about the error. }