开发者内部 UserID登录 - 探鸽开放平台API文档

开发者拥有自己的帐号体系时，传入用户的userId（开发者保证唯一性），可获得此用户在探鸽TIVS平台的登陆态access_token。TIVS平台将自动根据唯一ID创建开发者用户和探鸽平台内部用户的一一映射关系。
限开发者服务器调用，禁止在客户端调用，会启用服务器白名单检测。

注意：整个TIVS平台，仅有此接口user_id参数是开发者自己系统内的用户ID，此外未做特殊说明时，user_id参数均是TIVS平台的用户ID

详细说明文档及DEMO代码示例：https://tange-ai.feishu.cn/wiki/wikcn6GaETEIVO0jgCP1ASHf3Mg

请求参数

Header 参数

Authorization

string

签名字符串

必需

示例值:

TGV1-HMAC-SHA256 Credential=badfa2a9-e21d-4e5d-a00a-185eff8bf0d3/20240606/tgv1_request, SignedHeaders=content-length;content-type;x-tg-algorithm;x-tg-app-id;x-tg-date, Signature=7d17f98dd8e1245eb6ab55a34d0a21ba5f3024ac4e737fc97fa4c9d392efe1fc

Content-Type

string

必需

示例值:

application/json

Content-Length

integer

必需

计算出body的字符长度

示例值:

X-Tg-App-Id

string

必需

开发者帐号的APPID

默认值:

Accept-Language

string

必需

请求端的本地语言（zh-cn, zh-tw, en-us, ja, ko, vi, es, pt, ru, tr, de, it, fr, pl, th, ar）

默认值:

示例值:

zh-cnzh-twen-usjakoviesptrutrdeitfrplthar

X-Tg-Signed-Headers

string

必需

参与计算签名的header字段。POST等请求传入content-length;content-type;x-tg-app-id;x-tg-date，GET请求传入x-tg-app-id;x-tg-date

默认值:

x-tg-app-id;x-tg-date

示例值:

content-length;content-type;x-tg-app-id;x-tg-date

X-Tg-Date

string

必需

当前请求的UTC+0时间（注意时区，不是本地时区）

默认值:

20060102T150405Z

X-Tg-Content-Sha256

string

必需

将BODY数据进行SHA256计算后的值

X-Tg-Algorithm

string

必需

目前服务端接口使用的签名算法的版本号和哈希算法

默认值:

TGV1-HMAC-SHA256

Body 参数application/json

user_id

string

开发者自有用户ID

可选

如果有自己的账号体系，传自己账号体系的Userid；不传则登录当前开发者账号；不超过32字符

示例

{"user_id": "0"}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

可选

data

object

必需

access_token

string

授权令牌

必需

请求其他接口时必传

expires_in

integer

令牌有效期

必需

单位秒，如3600，表示1小时后token失效

user_id

integer

平台用户ID

必需

refresh_token

string

刷新token

必需

有效期30天，当access_token过期后，可用refresh_token调用接口，换取新的access_token

示例

{
    "code": 200,
    "msg": "ok",
    "data": {
        "access_token": "eyJhbGc1iOiJFZERTQSIsImtpZCI6Im8xWnkzWE5TSGhxOCIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1NjQxNTQzIiwiaXNzIjoiYXBwL2xvZ2luIiwiaWF0IjoxNjg5Njg1NTQxLCJleHAiOjE3MDQyMDA3NDEsImF1ZCI6WyJhcHAvYmFja21VuZCJdLCJnaWQiOiJxbXN5IiwidWlkIjo1NjQxNTQzLCJsYW5nIjoiemgtY24ifQ.SIHouY5-C0W3BdIgPUZqW_liDhaZ1bvrt3XYDU_-LvtsrTAQpQy-J36Op_WZ3AxIBQoOgBfLCIvdJ30hhpUu1Bg",
        "expires_in": 7200,
        "user_id": 1024,
        "refresh_token": "eyJhbGc1iOiJFZERTQSIsImtpZCI6Im8xWnkzWE5TSGhxOCIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1NjQxNTQzIiwiaXNzIjoiYXBwL2xvZ2luIiwiaWF0IjoxNjg5Njg1NTQxLCJleHAiOjE3MDQyMDA3NDEsImF1ZCI6WyJhcHAvYmFja21VuZCJdLCJnaWQiOiJxbXN5IiwidWlkIjo1NjQxNTQzLCJsYW5nIjoiemgtY24ifQ.SIHouY5-C0W3BdIgPUZqW_liDhaZ1bvrt3XYDU_-LvtsrTAQpQy-J36Op_WZ3AxIBQoOgBfLCIvdJ30hhpUu1Bg"
    }
}

🟠400错误

🟠401请登录

🟠403禁止访问

🟠404资源不存在

🔴500服务器内部错误