获取授权Access Token

# 获取授权Access Token

| 申请应用访问的应用Key、秘钥。 请联系超8运营人员开通。 |
|-------------------------------------------------------|

## 1. 获取Access Token

### **1.1 请求信息**

| 协议     | HTTPS                                                  |
|----------|--------------------------------------------------------|
| 域名     |                    |
| 请求方法 | POST                                                   |
| 请求路径 | /cncop/ca/v1/applications/get-token                    |
| 请求参数 |                                                        |
| 请求头   | Content-Type: application/json                         |
| 请求体   | JSON { "accessKey": "xxxx", "secretKeySign": "xxxxx" } |

**请求参数说明**

| 名称          | 类型   | 是否必填 | 示例                             | 说明                                                 |
|---------------|--------|----------|----------------------------------|------------------------------------------------------|
| accessKey     | String | 是       | eb5e78cca74647aa8dea4cb7d1cbb2f0 | 应用Key                                              |
| secretKeySign | String | 是       | f74d33728c81902d9e2730235d156764 | 应用秘钥的`MD5`签名。应用秘钥使用`MD5`生成`32位`小写签名。 |

### 1.2 响应信息

| HTTP状态码 | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 响应体     |  ``` {  "code": 200,  "message": "success",  "data": {  "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ5ZXNuby5jb20uY24iLCJhcHAiOiJ7XCJlbnRlcnByaXNlTm9cIjpcIjEzMTYzNDY1NDgzMFwiLFwiZW50ZXJwcmlzZVVzZXJJZFwiOlwiMTU0MDIwOTI1NzQ3MzkwMDU0NFwiLFwiYWNjZXNzS2V5XCI6XCJlYjVlNzhjY2Q3NDY0N2FhOGRlYTRjYjdkMWNiYjJmMFwiLFwiYXBwSWRcIjpcIjE1NzU0MTgwNzY5Nzc2MjMwNDBcIixcImVudGVycHJpc2VVc2VyQWNjb3VudFwiOlwiY2VzaGlsdW9uYW5cIn0iLCJzdWIiOiIxNTc1NDE4MDc2OTc3NjIzMDQwIiwiZXhwIjoxNjc3NzY2MjI5Njk3LCJpYXQiOjE2Nzc3Mzc0Mjk2OTcsImp0aSI6ImY5MDhkODUzMDllMDRiMGY4OGFlYTZlYzc1MTY2NjEwIn0.svjoZZ9CrboRPMKewaEGK7SXsoT3G-e5hdk33e3BioY",  "tokenTtl": "PT8H" ,"tokenTtlSeconds": 28800 },  "timestamp": 1677737429715,  "traceId": "182eb4f4-7c55-4a2c-a229-610492cf8d6f","exception": null,"meta": null,"ext": null } ``` |

响应头

Content-Type: application/json

**响应参数说明**

| 名称        | 类型   | 示例 | 说明                                                        |
|-------------|--------|------|-------------------------------------------------------------|
| code        | int    |      | 错误码，200：成功，其它为失败                               |
| message     | String |      | 错误信息                                                    |
| data        | JSON   |      | 响应结果                                                    |
| accessToken | String |      | 访问TOKEN ，开发者需要缓存 accessToken，不能频繁调用，否则会受到调用频率限流，请合理使用 accessToken 的有效期。                              |
| tokenTtl    | String | PT8H | TOKEN有效时长，ISO-8601格式。Java应用参考java.time.Duration |
| tokenTtlSeconds    | int |  | TOKEN有效时长, 单位：秒 |
| timestamp   | long   |      | 秒级时间戳 |
| traceId     | String |      | 链路信息 |
| exception     | String |      | 异常信息，一般用于开发调试，通常为null | 
| meta     | Object |      | 元数据信息，接口错误码翻译的占位符数据信息 | 
| ext     | Object |      | 扩展信息，自定义响应的扩展数据，通常为null |

### **1.3 错误码**

| 错误码   | 错误信息             |
|----------|----------------------|
| 200      | 成功                 |
| 21184031 | 应用账号或密钥不正确 |
| 21184032 | 应用账号被禁用       |
| 21184033 | 应用账号不存在       |
| 21180031 | Access Key不能为空   |
| 21180041 | 密钥不能为空         |
| 21185002 | 获取Token超出频率限制  |
| 500      | 未知错误             |

## 2\. **访问开放平台接口**

使用第一步获取的Access Token访问开放平台的接口

### **2.1 请求示例**

| Plain Text **GET** **https://sapi.supercarrier8.com/cncop/demo** **Authorization**: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ5ZXNuby5jb20uY24iLCJhcHAiOiJ7XCJlbnRlcnByaXNlTm9cIjpcIjEzMTYzNDY1NDgzMFwiLFwiZW50ZXJwcmlzZVVzZXJJZFwiOlwiMTU0MDIwOTI1NzQ3MzkwMDU0NFwiLFwiYWNjZXNzS2V5XCI6XCJlYjVlNzhjY2Q3NDY0N2FhOGRlYTRjYjdkMWNiYjJmMFwiLFwiYXBwSWRcIjpcIjE1NzU0MTgwNzY5Nzc2MjMwNDBcIixcImVudGVycHJpc2VVc2VyQWNjb3VudFwiOlwiY2VzaGlsdW9uYW5cIn0iLCJzdWIiOiIxNTc1NDE4MDc2OTc3NjIzMDQwIiwiZXhwIjoxNjc3NzY2MjI5Njk3LCJpYXQiOjE2Nzc3Mzc0Mjk2OTcsImp0aSI6ImY5MDhkODUzMDllMDRiMGY4OGFlYTZlYzc1MTY2NjEwIn0.svjoZZ9CrboRPMKewaEGK7SXsoT3G-e5hdk33e3BioY |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

### **2.2 说明**

-   访问开放平台接口时，只需要在请求头中添加访问Token： **Authorization: accessToken**
-  `开发者需要缓存 accessToken，不能频繁调用(1分钟内获取1次)，否则会受到调用频率限流，请合理使用 accessToken 的有效期 `

## 3\. **刷新Access Token策略**

Access Token存在有效期，本地代码实现如下两种刷新策略

### **3.1 定时刷新**

| 获取token需要请求方按照有效期进行缓存，接口做了频率限制，1分钟一次.  请注意！！！ |
|-------------------------------------------------------|

*TIPS: 为了避免频繁请求，可以设置如下刷新策略(示例)：*

*token有效期：60m*  此处为示例时间，实际以返回的字段时间为准

*刷新窗口：60/10=6m*

*最后一个刷新窗口：60-6=54m*

*记录最近一次刷新时间：2023-01-01 10:00:00*

*以下两种策略：*

*1. 当前时间=10:30.因为 距离上次刷新时间30m\<54m,不刷新*

*2. 当前时间=10.56.因为 距离上次刷新时间56m\>54m,处于最后一个刷新窗口,需要刷新*

*首次启动时,将执行一次刷新*

### **3.2 返回错误码时刷新**

当访问开放平台接口返回错误码为**20324012**、**20324013**时，需要刷新Access Token