鉴权

QuickCEP默认Host:http://openapi.quickcep.com/
身份验证
所有访问QuickCEP API均需要携带accessToken,放到请求Header X-QuickCEP-Access-Token中。
API scope

1.1.1 身份验证

GET /api/oauth/v1/token
请求样例

curl --location --request GET https://openapi.quickcep.com/api/oauth/v1/token?appId=xxx&appSecret=xxx

参数
参数名称 是否必填 类型 说明
appId 是 String 字符串
appSecret 是 String 字符串
返回值
正常
返回值名称 类型 说明
code Number 正常200
message String 接口返回信息
data object 返回业务数据
Data数据结构
参数名 类型 说明
accessToken String 访问令牌
isExpire Boolean 是否过期
expireIn Int 有效期(单位:毫秒)
身份验证失败
返回值名称 类型 说明
code Number 401
message String unauthorized或 appid 不存在
data Object null

1.1.2 AccessToken检查

GET /api/oauth/v1/token/check
请求样例

curl --location --request GET 'https://openapi.quickcep.com/api/oauth/v1/token/check?accessToken=xxx'

参数
参数名称 是否必填 类型 说明
accessToken 是 String 字符串
返回值
返回值名称 类型 说明
code number 正常200
message string 接口返回信息
data Object 返回业务数据
data数据结构
参数名 类型 说明
accessToken String 访问令牌
isExpire Boolean 是否过期
expireIn Int 有效期(单位:毫秒)

1.1.3 创建Scope

POST /api/oauth/v1/scope/create
Content-Type: application/json
请求样例

curl --location --request POST 'https://openapi.quickcep.com/api/oauth/v1/scope/create' \ --header 'X-QuickCEP-Access-Token: xxx' \ --header 'Content-Type: application/json' \ --data-raw '[ "write_email" ]'

参数
是否必填 类型 说明
是 Array 字符串数组
返回值
返回值名称 类型 说明
code Number 正常200
message string 接口返回信息
data object 返回业务数据

1.1.4 更新Scope

POST /api/oauth/v1/scope/update
Content-Type: application/json
请求参数

curl --location --request POST 'https://openapi.quickcep.com/api/oauth/v1/scope/update' \ --header 'X-QuickCEP-Access-Token: xxx' \ --header 'Content-Type: application/json' \ --data-raw '[ "write_email" ]'

参数
是否必填 类型 说明
是 Array 字符串数组
返回值
返回值名称 类型 说明
code Number 正常200
message String 接口返回信息
data object 返回业务数据

1.1.5 查询Scope

GET /api/v1/oauth/scope
请求样例

curl --location --request GET 'https://openapi.quickcep.com/api/oauth/v1/scope' \ --header 'X-QuickCEP-Access-Token: xxx'

参数
无
返回值
返回值名称 类型 说明
code Number 正常200
message String 接口返回信息
data object 返回业务数据

1.1.6 删除Scope

GET /api/oauth/v1/scope/delete
请求样例

curl --location --request POST 'https://openapi.quickcep.com/api/oauth/v1/scope/delete' \ --header 'X-QuickCEP-Access-Token: xxx'

参数
无
返回值
返回值名称 类型 说明
code Number 正常200
message String 接口返回信息
data object 返回业务数据
2024-06-17