> For the complete documentation index, see [llms.txt](https://mamba-dongdong.gitbook.io/pc-im/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mamba-dongdong.gitbook.io/pc-im/jie-kou-gai-shu.md).

# 接口概述

### API调用说明

本文档中，所有调用手工客服务端接口的请求都需要按此规则校验。

### API checksum校验

#### 以下参数需要放在Http Request Header中

| 参数       | 参数说明                                                                         |
| -------- | ---------------------------------------------------------------------------- |
| AppKey   | 手工客平台分配给开发者的AppKey                                                           |
| Nonce    | 随机数（最大长度128个字符）                                                              |
| CurTime  | 当前UTC时间戳，从1970年1月1日0点0 分0 秒开始到现在的秒数(String)                                  |
| CheckSum | SHA1(AppSecret + Nonce + CurTime)，三个参数拼接的字符串，进行SHA1哈希计算，转化成16进制字符(String，小写) |

CheckSum有效期：出于安全性考虑，每个`checkSum`的有效期为5分钟(用`CurTime`计算)，建议每次请求都生成新的`checkSum`，同时请确认发起请求的服务器是与标准时间同步的，比如有NTP服务。

CheckSum检验失败时会返回414错误码，具体参看[code状态表](https://mamba-dongdong.gitbook.io/pc-im/zhuang-tai-ma)。

**重要提示：本文档中提供的所有接口均面向开发者服务器端调用，用于计算CheckSum的AppSecret开发者应妥善保管,可在应用的服务器端存储和使用，但不应存储或传递到客户端，也不应在网页等前端代码中嵌入。**

### 接口说明

1. 所有接口都只支持POST请求；
2. 所有接口请求Content-Type类型为：application/x-www-form-urlencoded;charset=utf-8；
3. 所有接口返回类型为JSON，同时进行UTF-8编码。