# <font >获得密钥</font>
## 描述 

>获得玩家启动游戏的新密钥，需要为首次登录提供货币。 若无此帐号，将自动新增帐号。

> 请求方式（ Host-> BeSoft）:post 

> 编码方式：application/x-www-form-urlencoded

> Besoft响应的数据格式是: application/json

##  网址
>   {besoftapi}/api/game/getKey







## 请求参数
| 名称     | 类型     | 必要    |     描述        | 
| -------- | -------- | -------- |    -------- |  
| cert     | string     |   Y |     安全代码 |
| user      |string (30) |  Y |      每个网站上唯一的用户 ID（仅允许小写a-z 和 0-9）|
| userName  |String(50) |  Y |      显示BESOFT 內游戏里的名字, 最多支持 16 个 Unicode 字节|
| extension1 | string(20) | Y |     代理帐号（每一个代理帐号只能用于单一运营商） |


## 示例
- URL:
    - http://127.0.0.1:8000/api/game/getKey
- HTTP Method(请求方式)
    -   POST
- 表单数据
    > Content-Type: application/x-www-form-urlencoded
    ``` 
    cert:v8VMKKzlPpD0te4rX99Hgefs3PQrBFWJKiuUqg6Y
    user:test1
    extension1:adminweb
    ```
	
	

## 返回结果
| 名称     | 类型     | 必要    |     描述        | 
| -------- | -------- | -------- |    -------- |  
| status   | string     |   Y |     状态代码
|key    |string  |  Y |     访问令牌（默认有效时间：10 分钟）|
|returnurl| string | Y |     返回登陆游戏的url，必须添加gid指定登录游戏才能使用。 |

## 成功的结果

```
{
"status": 1,
    "key": "o7301PFJ6FkBQSTJpilxNgOnSVZfMb2rtdZGZAUCPxIAIJdfPCJKVbWBnjNeN256QjE8K19lO7S2SYWMPVQWy8",
    "returnurl": "https://127.0.0.1:8000/?key=o7301PFJ6FkBQSTJpilxNgOnSVZfMb2rtdZGZAUCPxIAIJdfPCJKVbWBnjNeN256QjE8K19lO7S2SYWMPVQWy8"
 }

```

## 失败的结果

> {“staus”:1001}


##  进入游戏

### 描述
>使用“key”（由 getkey api 返回）调用此方法以启动游戏。

>游戏返回说明：游戏关闭后，返回的地址（return_url=返回地址的参数）,如果不填写，游戏没有返回按钮。


## 网址
```
http://{BesoftFront}/?key=3F6AE577A2E2255EF4BACF02C9F8BB1154A9C6AD2F19701
568BA675BDA3C46BCA64D243007F87C86119329271708&gid=be001&lang=en&return_url=https://returnyoururl.com

```
>新开界面：如果需要直接关闭当前窗口，请使用window.open方式打开，并且不需要传入return_url


>新开界面：如果加入return_url参数,请以URLEncoding方式编码参数


>内嵌界面：如果是内嵌请监听此消息通知（closeMessage），游戏厂商关闭游戏的调用接口
```
{
   window.parent.postMessage("closeMessage", "*")
}

```


## 请求参数

| 名称     | 类型     | 必要    |     描述        | 
| -------- | -------- | -------- |    -------- |  
| acc     | String(30)     |   Y |     用户ID |
| key     |string(86) |  Y |从 getKey 接口拿到的 key。若使用 HTTP GET 方法，请以 URLEncoding 编码参数|
| aid | string(20) | Y |      代理帐号  |
| nick | string (50) | Y |     用户名，最多支持 16 个 Unicode 字节  |
| gid | Integer | Y |      预设登入的游戏 ID ;  |
| lang | string | Y |      默认值为简中 (简中 英文) |
| return_url | string | N |      return_url=游戏关闭的返回地址 ，请以URLEncoding方式编码参数|
##  返回结果

### 成功的结果

>Redirect Browser to gamehall page; 导引至游戏页面

### 失败的结果

>游戏界面显示相应的错误信息