# 礼包码接入

## 获取礼包码接口

### 简要描述

- 获取礼包码接口（后端调用，不要暴露给前端）

![获取接口](\zh\docs\GT\game-access\pc-game\choose\jiekou.jpg)

### 请求域名

- 国内域名：http://giftcode.youzu.com/ (支持https，适合国内游戏调用)
- 海外域名：http://giftcode.gtarcade.com/ (支持https，适合海外游戏调用)
- 测试环境域名：http://qagiftcode.gtarcade.com/

### 请求URL:

GET:/api/code

### 参数

| 参数名           | 是否必须 | 类型   | 说明                                                         |
| ---------------- | -------- | ------ | ------------------------------------------------------------ |
| account          | 是       | string | 前缀+内部账号，平台用户唯一标识                              |
| app_id           | 是       | string | 渠道app_id，礼包码后台配置，用于区分使用平台                 |
| platfrom_gift_id | 是       | int    | 平台礼包编号                                                 |
| time             | 是       | int    | 时间戳(秒)                                                   |
| sign             | 是       | string | 签名，具体方法请见sign算法，key为后台配置的渠道app_key       |
| token            | 是       | string | jwt形式的token，有效期3分钟，失效后重新调用/api/token重新获取。失效错误码参考状态码。延长有效期调用用/api/token-refreshment。调用延长有效接口时返回错误（只能延长在有效期内的token，且会返回新的token）则重新调用/api/token获取。token建议调用方业务服务器保存至缓存或者下发给用户端由用户端每次请求带回再由调用方透传至礼包码服务器 |

### 返回示例:

**正确时返回:**

```code
{
    "code": 0,
    "msg": "Success",
    "data": {
        "code": "BIJXKQONWX5"
    }
}
```

Code

Copy

**错误时返回:**

```code
{
  "code": 35
   "msg": "Token is expired"
}
```



## 使用礼包码接口

### 简要描述

- 使用礼包码接口（后端调用，不要暴露给前端）

### 请求域名

- 国内域名：http://giftcode.youzu.com/ (支持https，适合国内游戏调用)
- 海外域名：http://giftcode.gtarcade.com/ (支持https，适合海外游戏调用)

### 请求URL:

POST:/api/code/use-code

### 参数

| 参数名    | 是否必须 | 类型   | 说明                                                         |
| --------- | -------- | ------ | ------------------------------------------------------------ |
| account   | 是       | string | 前缀+内部账号，平台用户唯一标识                              |
| app_id    | 是       | string | 渠道app_id，礼包码后台配置，用于区分使用平台                 |
| code      | 是       | string | 礼包码，游族后台生成                                         |
| op_id     | 否       | int    | 运营商编号，游族定义，通过接口获取。注意手游使用的是开服系统的op_id，即运营商ID，并非opgame_id。 |
| game_id   | 是       | int    | 游戏编号，游族定义，通过接口获取                             |
| server_id | 是       | long   | 游戏区服编号                                                 |
| role_id   | 是       | string | 角色ID                                                       |
| ex_param1 | 否       | string | 扩展参数，调用方根据需要使用                                 |
| ex_param2 | 否       | string | 扩展参数，调用方根据需要使用                                 |
| sign      | 是       | string | 签名，具体方法请见sign算法，key为后台配置的渠道app_key       |

### 返回示例:

**正确时返回:**

```code
{
  "code": 0,
   "msg": "领取成功"
}
```

Code

Copy

**错误时返回:**

```code
{
  "code": 1,
   "msg": "领取失败"
}
```

Code

Copy