第三方接入

第三方系统接入相关接口

第三方用户登录

post

第三方系统通过此接口为用户获取 PayAll 平台的访问 Token。

这是第三方接入的第一步，成功调用后将返回用户 Token，后续所有 API 调用都需要使用此 Token 进行身份验证。

请求流程

1. 准备请求参数（account, expirationData, source, timestamp）

2. 使用商户私钥对参数进行签名，生成 sign 字段

3. 发送 POST 请求到 /thirdPartyLogin

4. 获取返回的 userToken，用于后续 API 调用

签名生成示例（伪代码）

# 1. 准备参数（不包含 sign）
params = {
    "account": "[email protected]",
    "expirationData": "2024-10-25 10:09:55",
    "source": "CatWallet",
    "timestamp": 1698203395
}

# 2. 按字典序排序
sorted_params = dict(sorted(params.items()))

# 3. 转换为 JSON 字符串
json_str = json.dumps(sorted_params)

# 4. 使用私钥加密并 Base64 编码
encrypted = rsa_encrypt(json_str, private_key)
sign = base64_encode(encrypted)

# 5. 添加到请求参数
params["sign"] = sign

Authorizations

BearerAuth

AuthorizationstringRequired

使用从 /thirdPartyLogin 接口获取的 userToken 进行身份验证。

在请求头中添加：

Authorization: Bearer {userToken}

示例：

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjM0LCJ1c2VyX2tleSI6InVzZXJAZXhhbXBsZS5jb20iLCJleHAiOjE2OTgyMDMzOTV9.xxxxx

注意：

• /thirdPartyLogin 接口不需要 Authorization header（用于获取 token）
• 其他所有接口都需要在请求头中携带 Authorization header
• Token 过期后需要重新调用 /thirdPartyLogin 获取新 Token

Body

application/json

Responses

200

登录成功

application/json

400

请求参数错误

application/json

500

服务器内部错误

application/json

post

/thirdPartyLogin

HTTPcURLJavaScriptPython

POST /v1/api/thirdPartyLogin HTTP/1.1
Host: api.payall.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 476

{
  "data": {
    "account": "[email protected]",
    "expirationData": "2024-10-25 10:09:55",
    "source": "CatWallet",
    "sign": "AJdzqyM5SSaewz7TF4M6cYK3NyVzz8tTjNpiGrlt3G+9Whncj2r8zMwNSkjyrvulSwZSIPFLCudIYiMI0BGSAGkLmVIwlZgZBvIRZwWlg0tt6hBvvEedRA1gCIVN4SSm4IKmnoxodOoRLL2MNrrTr7QvcUWZoSyElaCO3JL1cqwbReiAkIsy8kh0JQgZVhKX9fGlP07X3eXwdORr86DerBO/2Mv44XlJ8gTHwut9/pMkgveEh1pTKK0iFMIN00TA9wceRUZuuS7QegtK4hTLqoMz3m1saOYLNdTI7J9Qj1Wjf5SzGj5KIUkdqPK5GCAtzghRRWh4roYCiB0PE65crA==",
    "timestamp": 1698203395
  }
}

{
  "code": 200,
  "status": "true",
  "message": "success",
  "data": {
    "userToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjM0LCJ1c2VyX2tleSI6InVzZXJAZXhhbXBsZS5jb20iLCJleHAiOjE2OTgyMDMzOTV9.xxxxx",
    "account": "[email protected]",
    "userId": 12345
  }
}

查询登录态是否可用

get

查询当前 Token 的登录态是否有效。

功能说明

• 用于验证当前使用的 Token 是否仍然有效

• 如果 Token 有效，返回用户登录信息

• 如果 Token 失效，返回 401 错误，需要重新调用 /thirdPartyLogin 获取新的 Token

使用场景

• 在应用启动时检查 Token 是否有效

• 在调用其他 API 前验证 Token 状态

• 定期检查 Token 是否过期，提前刷新

注意事项

• 此接口需要在请求头中携带 Bearer Token

• 如果返回 401 错误，表示 Token 已失效，需要重新调用 /thirdPartyLogin 获取新 Token

Authorizations

BearerAuth

AuthorizationstringRequired

使用从 /thirdPartyLogin 接口获取的 userToken 进行身份验证。

在请求头中添加：

Authorization: Bearer {userToken}

示例：

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjM0LCJ1c2VyX2tleSI6InVzZXJAZXhhbXBsZS5jb20iLCJleHAiOjE2OTgyMDMzOTV9.xxxxx

注意：

• /thirdPartyLogin 接口不需要 Authorization header（用于获取 token）
• 其他所有接口都需要在请求头中携带 Authorization header
• Token 过期后需要重新调用 /thirdPartyLogin 获取新 Token

Responses

200

Token 有效，登录态可用

application/json

401

Token 失效，需要重新登录

application/json

500

服务器内部错误

application/json

get

/checkLogin

HTTPcURLJavaScriptPython

GET /v1/api/checkLogin HTTP/1.1
Host: api.payall.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": 200,
  "status": "true",
  "message": "success",
  "data": {
    "is_login": true,
    "account": "u***@example.com",
    "user_id": 12345
  }
}