返回结果

状态码

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。

对于使用Token Exchange模式获取access_token接口，如果调用后返回状态码为"200"，则表示请求成功；返回非200状态码表示请求失败，具体失败信息以JSON格式返回。

响应消息头

对应请求消息头，响应同样也有消息头，如“Content-Type”。DocZip开放API的响应消息头中包含业务跟踪ID，可用于问题排查。

公共响应头：

响应消息体

响应消息体通常以JSON结构化格式返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。DocZip开放API的响应消息体为可选部分，各接口的响应字段详见对应接口说明。

对于使用Token Exchange模式，获取的用户access_token接口，当接口调用成功时，HTTP状态码为 200，返回如下消息体。其中，“access_token”是需要获取的用户Token，取值以变量“XXX”表示。有了Token之后，您可以使用access_token认证调用其他API。

{
  "access_token": "XXX...",
  "refresh_token": "YYY...",
  "token_type": "Bearer",
  "expires_in": 7200,
  "scope": "*"
}

当接口调用失败时，会返回错误码“400”及错误信息说明，错误响应的Body体格式如下所示。

{
  "error_code": "KPGE.00001000",
  "error_msg": "参数错误"
}

其中，error_code表示错误码，error_msg表示错误描述信息。