接口说明
请求URI
/app/getAuthCode
功能描述
获取企业自建应用授权code
注意事项
注意： 环境域名。只有自建应用方式创建的开放平台opfid账号才需要会使用到该API。
调用方式
HTTPS 调用
GET https://integrate.rabbitpre.com/api/open/app/getAuthCode
请求数据类型
[ "application/json" ]
响应数据类型
[ "*/*" ]
请求头参数
属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
X-Token | string | 是 | 自建应用企业orgAccessToken。1、获取企业自建应用访问token |
请求参数
属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| accountType | string | 是 | 账号类型：1-手机、2-邮箱、4-开放平台的方式联合登录 |
| account | int32 | 是 | 账号(手机或邮箱) |
| companyId | string | 否 | 第三方企业id（为空代表主企业，否则为租户） |
| uid | string | 是 | 第三方用户id |
返回参数
属性 | 类型 | 说明 |
|---|---|---|
code | string | 响应状态码。200-请求成功， 100100-appid、secret错误， 100200-token错误 ，100300-授权code错误 |
data | Object | 数据对象 |
| └─authCode | string | 企业授权code |
errorCode | string | 错误码 |
msg | string | 消息提示 |
调用示例
示例说明: HTTPS调用
请求数据示例
{
"accountType": 4,
"account": "13400003333",
"companyId": "10001",
"uid": "1000110001"
}
返回数据示例
{
"code":"200",
"data":{
"authCode":"aaa-bbb-ccc-ddd",
},
"errorCode":"0",
"msg":"操作成功"
}
错误码
错误码 | 错误码取值 | 解决方案 |
|---|---|---|
| 200 | Success | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
获取企业自建应用授权code
接口地址 https://integrate.rabbitpre.com/api/integrate/app/getAuthCode
请求方式 GET
consumes ["application/json"]
produces ["*/*"]
接口描述 requestHeader携带X-Token={orgAccessToken}
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| X-Token | 企业访问token | header | true | string | |
| accountType | 账号类型：1-手机、2-邮箱、4-开放平台的方式联合登录 | query | true | integer | |
| account | 账号(手机或邮箱) | query | true （联合登录账号为空） | string | |
| companyId | 第三方企业id（为空代表主企业，否则为租户） | query | false （联合登录参数） | string | |
| uid | 第三方用户id | query | true （联合登录参数） | string |
响应状态
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | ApiResponse«授权code响应实体» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
响应参数
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | string | ||
| data | string | 授权code响应实体 | |
| errorCode | string | ||
| msg | string |
schema属性说明
授权code响应实体
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| authCode | 企业授权code | string |
响应示例
{
"code": "",
"data": {
"authCode": ""
},
"errorCode": "",
"msg": ""
}