account_sync.md 1.7 KB

统一认证平台 - 账号同步 (M2M)

1. 概述

用于将外部业务系统(如 OA、CRM)的用户账号关系同步到本平台。支持批量调用。

Base URL: {{API_BASE_URL}}

2. 认证方式

此接口不使用签名算法,而是使用 App Access Token

  • Header: X-App-Access-Token: <YOUR_TOKEN>
  • Token 可在平台管理界面的应用详情页查看。

3. 同步接口 (Sync)

创建或更新用户,并建立应用映射关系。

  • URL: POST /apps/mapping/sync
  • Content-Type: application/json

逻辑

  1. 根据 mobile 查找用户。若不存在则自动创建(随机密码)。
  2. 更新该用户与当前应用的映射 (mapped_key, mapped_email)。

Request Body

Field Type Required Description
mobile string Yes 用户手机号 (平台唯一标识)
mapped_key string No 外部系统用户ID
mapped_email string No 外部系统邮箱
is_active boolean No 映射状态 (默认 true)

示例

curl -X POST "{{API_BASE_URL}}/apps/mapping/sync" \
     -H "Content-Type: application/json" \
     -H "X-App-Access-Token: eyJhbGci..." \
     -d '{
           "mobile": "13800138000",
           "mapped_key": "user_1001",
           "mapped_email": "zhangsan@example.com"
         }'

Response (200)

{
  "id": 123,           // 映射记录 ID
  "user_id": 456,      // 平台用户 ID
  "user_mobile": "13800138000",
  "mapped_key": "user_1001",
  "is_active": true
}

4. 错误码

  • 400 Bad Request: 参数错误或映射关系冲突(如 mapped_key 已被占用)。
  • 403 Forbidden: Token 无效。