开放文档API

获取凭证 (AppId & AppSecret)

在调用任何 API 之前，您需要拥有有效的应用凭证：

• AppId：您的应用唯一标识。
• AppSecret：用于验证您身份的密钥。

请前往 云银签开发者平台（具体地址请咨询平台管理员）注册账号、创建应用，并在应用详情中获取您的 AppId 和 AppSecret。

获取 Access Token

所有业务 API 的调用都需要一个有效的 `accessToken` 进行身份验证。您需要使用您的 AppId 和 AppSecret 调用以下接口来获取它：

接口： POST /service/getAccessToken (查看接口详情)

请求 Body (JSON):

{
  "appId": "YOUR_APP_ID",       // 替换为您的 AppId
  "appSecret": "YOUR_APP_SECRET" // 替换为您的 AppSecret
}

请求示例 (Curl):

curl -X POST 'https://your-api-host.com/service/getAccessToken' \
-H 'Content-Type: application/json' \
-d '{
  "appId": "YOUR_APP_ID",
  "appSecret": "YOUR_APP_SECRET"
}'

成功响应示例:

{
  "code": "0",
  "msg": "success",
  "data": {
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", // 这就是您需要的 Access Token
    "expiresIn": 1686096000000, // Token 过期时间戳 (毫秒)
    "corpId": 12345 // 关联的企业ID
  }
}

获取操作者 userId

在调用具体的业务接口前，您需要知道是**哪个用户**在执行这个操作。这个用户必须是您企业在云银签系统中的成员。您需要获取该用户的 `userId`。

接口： POST /member/infoByCorpId (查看接口详情)

关键：调用此接口时，需要在 **请求 Header** 中携带 `appId` 和上一步获取的 `accessToken`。

请求 Header 示例:

appId: YOUR_APP_ID
accessToken: PREVIOUSLY_OBTAINED_ACCESS_TOKEN

请求 Body (JSON, 以手机号查询为例):

{
  "mobile": "13800138000" // 需要查询的操作者手机号
}

成功响应示例 (JSON):

{
  "code": "0",
  "msg": "success",
  "data": [ // 可能返回多个，如果查询条件不唯一
    {
      "userId": 20001, // 这就是您需要的操作者 userId
      "userName": "张三",
      "mobile": "13800138000",
      // ... 其他用户信息字段
    }
  ]
}

调用业务 API (以查询用户信息为例)

获取到 `accessToken` 和操作者 `userId` 后，您就可以调用具体的业务接口了。**调用业务接口时，必须在请求 Header 中统一携带以下四个基本参数：**

• appId: 您的应用 ID。
• accessToken: 您获取到的有效令牌。
• userId: 当前操作者的用户 ID。
• source: 标识请求来源客户端类型。

请求 Header 示例:

appId: YOUR_APP_ID
accessToken: PREVIOUSLY_OBTAINED_ACCESS_TOKEN
userId: 20001
source: pc

`source` 参数说明:

pc:

电脑端

app:

手机端 App

h5:

H5 页面

wx:

微信小程序

alipay:

支付宝小程序

我们以查询指定用户信息为例：

接口： POST /member/infoByUserId (查看接口详情)

请求 Body (JSON, 仅包含业务参数):

{
  "userId": 20002    // 需要查询的用户 ID
}

成功响应示例 (JSON):

{
  "code": "0",
  "msg": "success",
  "data": [ // 可能返回多个，如果查询条件不唯一
    {
      "userId": 20001, // 这就是您需要的操作者 userId
      "userName": "张三",
      "mobile": "13800138000",
      // ... 其他用户信息字段
    }
  ]
}

恭喜！您已成功完成第一个 API 调用。现在您可以根据业务需求，浏览下方的 API 目录，查找并调用其他接口了。