|
@@ -1,37 +1,87 @@
|
|
|
# TMS外链接口文档
|
|
|
|
|
|
-#### 介绍
|
|
|
-TMS外链接口文档
|
|
|
+## 目录
|
|
|
+- [简介](#一、简介)
|
|
|
|
|
|
-#### 软件架构
|
|
|
-软件架构说明
|
|
|
|
|
|
+## 一、简介
|
|
|
|
|
|
-#### 安装教程
|
|
|
+用于将TMS系统中的部分功能集成在外部系统
|
|
|
|
|
|
-1. xxxx
|
|
|
-2. xxxx
|
|
|
-3. xxxx
|
|
|
+## 二、对接方式
|
|
|
|
|
|
-#### 使用说明
|
|
|
+首先调用登陆接口进行登录,之后再调用其他接口。接口的请求地址为系统域名:
|
|
|
+- **测试环境**:go3tms.test.56ctms.com
|
|
|
+- **正式环境**:go3tms.kuaihuoyun.com
|
|
|
+**独立部署用户请使用自己的域名**
|
|
|
+请求示例:http://go3tms.test.56ctms.com/ttms/account/outerLogin?phone=123456789&password=123456
|
|
|
|
|
|
-1. xxxx
|
|
|
-2. xxxx
|
|
|
-3. xxxx
|
|
|
|
|
|
-#### 参与贡献
|
|
|
+## 三、接口详细信息
|
|
|
|
|
|
-1. Fork 本仓库
|
|
|
-2. 新建 Feat_xxx 分支
|
|
|
-3. 提交代码
|
|
|
-4. 新建 Pull Request
|
|
|
+### 登陆接口
|
|
|
|
|
|
+**简要描述:** 用于登陆系统,登陆以后才能做后续操作
|
|
|
|
|
|
-#### 码云特技
|
|
|
+**请求 URL:** `/ttms/account/outerLogin`
|
|
|
|
|
|
-1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md
|
|
|
-2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com)
|
|
|
-3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
|
|
|
-4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目,是码云综合评定出的优秀开源项目
|
|
|
-5. 码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
|
|
|
-6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
|
|
|
+**请求方式:** POST
|
|
|
+
|
|
|
+**请求参数:**
|
|
|
+
|
|
|
+| 参数名 | 必选 | 类型 | 说明 |
|
|
|
+|:----:|:---:|:-----:|:-----:|
|
|
|
+| `phone` | 是 | `String` | `账号` |
|
|
|
+| `password` | 是 | `String` | `密码` |
|
|
|
+
|
|
|
+**返回示例**
|
|
|
+
|
|
|
+- 调用成功示例
|
|
|
+
|
|
|
+```java
|
|
|
+{
|
|
|
+ "status": 200,
|
|
|
+ "body": "Success!",
|
|
|
+ "message": null
|
|
|
+}
|
|
|
+```
|
|
|
+- 调用失败示例
|
|
|
+
|
|
|
+```java
|
|
|
+{
|
|
|
+ "message": "密码不符",
|
|
|
+ "status": 500
|
|
|
+}
|
|
|
+{
|
|
|
+ "message": "账号无效",
|
|
|
+ "status": 500
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+### 受理单智能追踪接口
|
|
|
+
|
|
|
+**简要描述:** 获取受理单智能追踪页面
|
|
|
+
|
|
|
+**请求 URL:** `/ttms/jumpToOmsTracker`
|
|
|
+
|
|
|
+**请求方式:** POST
|
|
|
+
|
|
|
+**请求参数:**
|
|
|
+
|
|
|
+| 参数名 | 必选 | 类型 | 说明 |
|
|
|
+|:----:|:---:|:-----:|:-----:|
|
|
|
+| `customerOrderNumber` | 是 | `String` | `受理单号` |
|
|
|
+
|
|
|
+**返回示例**
|
|
|
+
|
|
|
+- 调用成功示例
|
|
|
+
|
|
|
+<div align="center">
|
|
|
+<img src="img/img_customer_order_tracker_success.png" width = "400" height = "300" alt="车次订阅接口状态"/>
|
|
|
+</div>
|
|
|
+
|
|
|
+- 调用失败示例
|
|
|
+
|
|
|
+<div align="center">
|
|
|
+<img src="img/img_customer_order_tracker_error.png" width = "350" height = "300" alt="车次订阅接口状态"/>
|
|
|
+</div>
|