EagletAPI / OpenAPI / 设置回调地址

设置回调地址

接口描述: 当前用户已提交航空提单号的轨迹有更新时,系统会调用当前用户设置的Webhook URL,将轨迹数据同步给当前用户。

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
url字符串必须-回调地址
sign字符串必须-验证签名

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.id字符串数据id。
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
url 必须
sign 必须

客户端请求示例

{
  "ret": 200,
  "data": {
    "id": 1
  },
  "msg": ""
}

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
500表示服务端内部错误

本文档生成时间:2024-07-17 17:37:52