同步用户

更新时间:2024-03-18 07:45:08下载pdf

本文介绍同步用户的 API。

接口描述

该 API 用于 App 账号同步。 当您需要将内部的用户账号与涂鸦的用户平台建立绑定关系时,您可以选择将用户进行同步。当您第一次同步账号时,涂鸦将依据您给的参数创建一个用户,并返回涂鸦平台的用户 ID。当您下一次再用相同的参数进行同步时,将不会再创建新的用户,而是返回第一次创建的平台用户 ID。

您可结合具体的业务场景,根据不同的同步参数来完成账号的创建和账号信息修改。

说明:
账号一经创建后,国家码、用户名和用户名类型无法修改。请在创建时确认对应数据。
在同一应用下,如果传入相同用户名,则会根据具体同步参数,来更新该用户上一次的密码、昵称或时区 ID。

接口地址

POST: /v1.0/apps/{schema}/user

请求参数

参数名类型参数位置是否必填说明
schemaStringuritrueApp 渠道标识符。

body 说明

参数名类型参数位置是否必填说明
country_codeStringbodytrue国家码。
usernameStringbodytrue用户名。
passwordStringbodytrue用户密码,请使用 MD5 Hash 加密用户的原始密码作为传入参数
username_typeIntegerbodytrue用户名类型。取值说明如下:
  • 1:手机号码。
  • 2:邮箱地址。
  • 3:其他。默认值为 3
nick_nameStringbodyfalse昵称。
time_zone_idStringbodyfalse时区 ID。

返回参数

参数名类型说明
resultJSONObject用户返回实体。

result 说明

参数名类型说明
uidString涂鸦用户 ID。

请求示例

POST: /v1.0/apps/testApp/user
{
  "country_code": "86",
  "username": "182*****678",
  "password": "c7fb2740c5f******4ed765a479fa",
  "username_type": 1,
  "time_zone_id": "Asia/Shanghai"
}

返回示例

{
    "result": {
        "uid": "ay1534*****4744oIAa"
    },
    "success": true
}

错误码

参考 错误码