RCS接口文档

欢迎使用中扬RCS开放平台 API。本文档提供了完整的接口说明,包含请求参数、返回结果以及示例代码。每个接口都提供了 Mock 功能,方便您快速测试和集成。

📌 快速对接指南

接口中标 * 的为常用接口,初步对接时,只需要调通以下接口:

如果上层系统需要接收任务的执行状态,需要提供以下接口,供调度系统回调:

⚠️ 超时设置:中扬调度系统调用上层系统的接口,获取连接超时时间默认为 30秒,数据返回超时时间默认为 60秒,超时情况下,调度系统会返回连接失败。

📋 对接约定

接口概览

🔗 基础信息

基础 URL http://IP:PORT
请求格式 application/json
返回格式 application/json
字符编码 UTF-8

📋 通用请求参数

以下参数为所有接口的通用参数,每次调用时需要携带:

参数名 是否必填 描述
reqTime 选填 请求时间戳,格式: yyyy-MM-dd HH:mm:ss。由上层系统设定。
tokenCode 选填 令牌号,由调度系统颁发。如果填写,需先在 RCS-2000 系统配置,上层系统调用时进行填写。

📤 通用返回值定义

所有接口的响应都遵循以下统一格式:

参数名 是否必填 描述
code 必填 返回编号,200 表示成功,1~N 表示失败
message 必填 返回消息,请求成功 表示成功,内容为详细的错误描述
data 选填 返回的数据结构,具体内容根据接口而定

错误码说明

通用错误码

错误码 说明 解决方案
200 成功 -
500 参数错误 检查请求参数是否完整和正确

以上内容对您有帮助吗?