全尚开放标准API

全尚开放标准API接入开发指南

1 总体接入流程步骤示意图

我司采用IP白名单+固定令牌的双重校验方式，完成对API访问控制以及身份认证。

1. 提供调用方服务器IP: 联系我司开发人员配置调用方IP白名单，这样可以防止非白名单IP随意调用，避免对服务器造成压力以及数据的窃取。
2. 需要固定令牌: 令牌是目前用来做用户认证的，表明此次调用是哪方系统的调用，也是我司后期权限化以及接口调用频率的根据，请妥善保存并请勿对外泄露。
3. 测试环境双方调试：上线前必备操作，对接双方依据接口规范及文档，进行接口调试。
4. 上线

2. 网络接口访问示意图

3. 接口规范说明

3.1 通讯协议

• REST风格的API，使用HTTP协议发送POST请求调用接口。
• HTTP请求头类型为 Content-Type: application/json

3.2 报文及报文编码

• 报文为UTF8编码，支持半角、中文、英文、数字、基本标点符号，请注意不要有表情符号等各种非法字符，会导致数据库写入失败。
• 请求报文统一用json格式

3.3 接口文档说明

• 3.3.1 接口说明
  用于接口描述、接口级别注意事项、敏感数据，以及建议调用方式等。

• 3.3.2请求参数说明
  描述了请求报文所有输入参数的含义及注意事项。

• 3.3.3 请求地址（url）
  接口文档该部分描述了每个接口的测试和正式环境请求地址，注：不同接口变更“接口服务名”即可。
  1）测试环境：http://apitest.yptcgroup.com/thirdpart/接口服务名
  2）预发布环境：http://apiuat.yptcgroup.com/thirdpart/接口服务名
  3）正式环境：http://api.yptcgroup.com/thirdpart/接口服务名

• 3.3.4 公共请求参数
  每个接口都必须输入的参数。接口文档该部分阐述了请求报文中公共请求参数的含义及注意事项，参数详见下述表格。