API调用指南
API是基于HTTPS协议来调用的。
一、调用流程
填充参数 > 拼装HTTP请求 > 发起HTTP请求 > 获得HTTP响应 > 解析json结果
二、调用地址
API调用地址为如下,请访问时拼接对应方法uri:
https://dzapi.ningmengyun.com/dz_api/
三、调用方式
请查看相应接口的API文档。
四、公共参数
调用每个接口时,需要在请求头中添加两个参数:
请求头 | 描述 |
---|---|
Authorization | 用户Token |
AaId | 代账公司ID |
五、业务参数
API调用除了必须包含公共参数外,如果API本身有业务级的参数也必须传入。
每个API的业务参数请参考API文档
六、调用示例
GET https://dzapi.ningmengyun.com/dz_api/Customer/GetFollowup?custId=100000001
七、返回结果示例
{
"StatusCode": 200,
"Data": [
{
"CustId": 100000002,
"Content": "111",
"FollowupId": 100000005,
"CreatedBy": 801377,
"CreatedName": "18210898617",
"CreatedDate": "0001-01-01T00:00:00",
"FollowupTime": "2020-08-24T21:34:40",
"StrFollowupTime": "2020-08-24",
"CanbeEdited": true,
"Attachments": []
}
],
"Success": true,
"Message": ""
}
Data:返回的数据
Success:正常返回为true,发生错误为false
Message:Success为false时的错误信息