Skip to content

简化版认证 OpenAPI

简化版认证主要面向开发者用户,用于体验UBI SDK功能。UBI Android SDK Demo

线上运行的认证流程比较复杂,但是安全性高。 简化版认证认证简单,但是安全性低。

注意:正式运行建议使用安全性高的认证流程

接口说明

获取授权码

1
GET /v1/generate-code/{orgUserId}

说明

获取授权码,用此授权码获取UBI passport token

git。此UBI passport token 有效时长为2小时。当授权码回收之后不可在获取UBI passport token

请求参数

成功响应

HTTP 状态码 类型 说明
200 SuccessResult 授权码
400 ErrorResult 请求参数不合法
500 ErrorResult 系统错误

示例请求

请求 path
1
GET /v1/generate-code/202203011725
成功响应

HTTP 200 OK

1
2
3
{
  "code": "0upg1946v4"
}

获取UBI passport token

1
GET /v1/access-token/{code}

说明

根据授权码获取UBI passport token,携带此UBI passport token调用ubm sdk接口体验UBM SDK等功能。

请求参数

成功响应

HTTP 状态码 类型 说明
200 TokenResult 授权码
400 ErrorResult 请求参数不合法
500 ErrorResult 系统错误

请求示例

请求 path
1
GET /v1/access-token/0upg1946v4
响应

HTTP 200 OK

1
2
3
{
  "accessToken": "eyJraWQiOiJ1Ym1fc2RrX3VzZXIiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIxMTAwMDAwMDAwOSIsIm5iZiI6MTY0NTc4MDU3NCwiYXBwaWQiOiIxMTA4NjE1OTkiLCJpc3MiOiJoYW9jaGV6aHUuY2x1YiIsImNsaWVudCI6IjIxMDAwMDEiLCJyZWFsbSI6Im9wZW5fYXBpIiwiZXhwIjoxNjQ2Mzg1Njc0LCJpYXQiOjE2NDU3ODA4NzQsIm9yZ1VzZXJJZCI6ImJ4Y2xfdGVzdHVzZXIifQ.RMiepCP1DJNlCZUartPLvrMvxtR9f8snNmPsw9s12y7BQF1j4pMc0VsnqcHyU13PWZNovrex-D3EQvPTXCmrKN1pLpbhpTuPyt6TlIeA6C-uuMYXtT0Te4at1c8cnk4yVbCAtrjPaD7fo0YBlYdapJdmvRpJU9qj5kM-hOZL8dKsilbUlXx_5C1JMRfHsFM3mlXSRSYpQ2k4uxmbfYFsuDzMer0AhsIw4dgXFcw-7ArOEQwFCjBPd9KQWIxaU979ESO-w0m1I1kfr0pWbvWWzuvRorIl7e5iNP3y7nPgbtT1-0GRJpGc9kyyKJLTr_8s4p8EBikWbGLmjib_WgbKNQ"
}

回收授权码

1
GET /v1/cancellation/{code}

说明

回收授权码,当授权码回收之后,此授权码则不能在换取UBI passport token

参数

成功响应

HTTP 状态码 类型 说明
200 CodeResult 授权码
400 ErrorResult 请求参数不合法
500 ErrorResult 系统错误

请求示例

请求 path
1
GET /v1/cancellation/0upg1946v4
成功响应

HTTP 200 OK

1
2
3
{
  "result": "true"
}

数据类型说明

SuccessResult

名称 类型 说明
code * string 授权码,通过此授权码换取UBI passport token

TokenResult

名称 类型 说明
accessToken * string UBI passport 签发的UBI passport token

CodeResult

名称 类型 说明
result * boolean 授权码回收是否成功