交互技术说明

2.交互技术说明#

2.1 接口传输协议：HTTPS接口
2.2 请求方式：Restful数据
2.3 编码格式：UTF-8
2.4 数据传输格式：JSON

2.2 接口服务地址#

为了便于外部系统方便接口的对接与测试工作，防止上线后对正式系统造成影响，澜码大模型应用平台的接口环境分为接口测试环境和生产环境。

2.3 接口输入参数说明#

澜码大模型应用平台所有接口的请求参数归类为系统类和应用类，系统类参数主要用于接口签权及安全控制；应用参数为API接口参数。

2.4 接口返回数据格式#

所有接口，平台返回的数据结构以JSON字符串的方式传输，具体示例见接口说明。

接口返回参数说明

2.5 接口安全控制#

平台的标准接口并不涉及交易或用户敏感信息，因此在接口安全控制方面基于性能考虑仅采用简单防篡改的安全控制策略，数据的传输也以明文方式进行，并不做特殊加密处理，目前仅使用 Https 加密传输方式保障传输过程不被篡改。

2.5.1 访问授权#

平台的接口访问必须经过澜码大模型应用公司的授权后才可以访问与使用，授权通过向外部系统发放授权的 ApiKey 的方式，外部系统在访问澜码应用平台的接口时，必须在 Header 中将 ApiKey 设置到 Authorization，否则接口访问将被拒绝服务。

2.5.2 数据防篡改#

在 Restful 使用中为了保证数据的传输过程中不被篡改，接口采用 HTTPS 加密协议来传输数据。HTTPS 提供端到端的安全通信，可以在一定程度防止中间人攻击和篡改。此外，ApiKey 作为全局唯一密钥本身不包含敏感性信息，也不具备逆向反推破解。

2.5.3 接口请求有效性#

为了控制接口调用的时间有效性，避免一个请求被截取后，此请求会不断的有效 ，澜码大模型应用平台设置了接口请求的有效时间为 1200 秒。

2.5.4 IP 白名单#

为了保障数据访问的稳定与有效处理，避免非授权方的非法访问影响正常合作客户的数据请求，澜码大模型应用平台数据接口服务设置了 IP 白名单，只有加入 IP 白名单的数据请求才能正常被接收和处理。

2.6 获取或添加密钥#

2.6.1 登录 askxbot 系统#

测试环境：http://test.api.xbotspace.com/login?key=xxx
生产环境：https://askxbot.xbotspace.com/login?key=xxx

2.6.2 系统左下角点击[管理]，再点击[密钥管理]。#

2.6.3 获取或创建密钥#

2.7 注意事项#

在调用接口时，以下code码状态需要注意，请参考以下说明：

2.7.1 code 为 401#

a. 异常原因 ：令牌缺失或鉴权失败。
b. 解决方案：检查访问 Header 中的 Authorization 是否有设置，ApiKey 管理页面查看是否过期以及 ApiKey 是否被删除。 401 归类为令牌类型的异常，具体错误可参message 返回信息。

2.7.2 code 为 403#

a. 异常原因 ：接口没有调用权限或接口某些功能范围受限。
b. 解决方案：确认调用的接口或接口功能在有效范围。

2.7.3 code 为 404#

a. 异常原因 ：接口不存在。
b. 解决方案：请检查请求的URL地址与文档是否符合。