# 开始上手

开放平台的接口基于HTTP接口,你可以使用任何开发语言进行网络请求。

# 身份验证

每次网络请求,你都需要在请求的头(header)里添加一个名为token的键值,用来表示你的身份。 token的值计算方式如下:

token = appKey + "$$" + timestamp + "$$" + MD5(appSecret + timestamp)

token是一个字符串,由三部分组成,用$$隔开并拼接在一起。

# appKeyappSecret

请在开放平台 (opens new window)上获取这两个值。请妥善保存你的appSecret防止泄露,以免造成损失。

# timestamp

timestamp为当前请求的UNIX时间戳(精确到毫秒),如“1585135635331”,时间戳与真实请求时间的误差超过半小时,则本次请求将会被服务器中止。

# MD5

MD5即为MD5加密算法,大小写皆可,请根据你使用的开发语言自行寻找该算法的实现。请注意appSecret和timestamp的先后顺序。

# header说明

header中的Content-Type请设置为application/json或为空,否则可能无法正常进行网络请求,但可能也有例外,如有例外将会标注在页面上。

# 服务器返回

你的每次请求,服务器都会返回一串JSON格式的字符串来表示本次请求的结果。 返回值如下格式:

{
    "code": 0,
    "message": "success",
    "data": {
        "xxx": xxx
    }
}

失败时请求类似如下:

{
    "code": -1,
    "message": "文件不存在"
}

# code

code代表了返回结果的类型,为0时代表本次请求成功,其他值则为失败。失败时请阅读服务器返回的message以查看更多的错误信息。

# message

message代表了返回结果的信息,为success时代表本次请求成功,其他值为失败。

# data

data代表了返回的数据,如果无返回数据,或code不为0时,该字段不存在

# 测试一下

团子提供一个测试接口,可以验证你的token以及请求头是否正确,在您两项均设置无误的情况下,调用下方地址将返回“ok”字样,否则token请求头必定设置错误。

请求地址:

GET/POST https://api.dango.ai/echo

返回举例:

{
	"code": 0,
	"message": "success",
	"data": "ok"
}
最后更新时间: 2/9/2022, 3:36:24 AM