开发指南

# 开发指南

# 介绍

平台的api开放了丰富的能力接口,可以实现流程提交、主表子表数据新增删除等。

所有的接口需使用HTTP协议、JSON数据格式、UTF8编码。接口说明格式如下：

```
请求方式：GET/POST   
请求地址:http://localhost:5000/api/FrontEnd/...  
请求实体:  
 ...  
请求示例:  
 ...  
返回结果:  
 ...  
返回示例:  
 ...

```

# 接口调用流程

* ![](/media/202507//1753065628.6195717.png)获取token，参考：[获取token](http://invalid.uri)

* 缓存和刷新token：开发者需要缓存token，用于后续的接口调用。token有效时间为2小时，当token失效或过期时，需要重新获取。

* 调用具体的业务方法：

api的请求标头中需要Authorization、UserId、TnCode

1. Authorization：Bearer \<token\>

1. UserId：调用者用户id

1. TnCode：租户code

# api返回值说明

**返回结果**

| 参数名 | 类型 | 说明 |
| --- | --- | --- |
| Code | int | 状态码:200表示成功，201表示失败 |
| Message | string | 错误消息（当Code为201时，返回错误消息内容） |
| Result |  | 执行结果 |
| Status | int | 状态：1表示成功，0表示失败 |

**返回示例(成功)：**

```
{  
 "Code": 200,  
 "Message": "",  
 "ExceptionSeqNo": null,  
 "Result": true,  
 "Status": 1,  
 "MessageShowType": 0  
}  
```

**返回示例(失败)：**

```
{  
 "Code": 203,  
 "Message": "objectId\[205e4ed8\-db1f\-40c7\-9e2d\-bf656d53c2c1]该数据已存在",  
 "ExceptionSeqNo": null,  
 "Result": null,  
 "Status": 0,  
 "MessageShowType": 0  
}

```