识别客户
POST/api/v1/customers
按 App、环境和 externalUserId 查找或创建客户。重试不会覆盖已有资料。省略 externalUserId 时按邮箱预建客户；之后带相同已验证邮箱的 externalUserId 会就地认领它。
SDK 0.0.1更新于
发起请求
按 App、环境和 externalUserId 查找或创建客户。重试不会覆盖已有资料。省略 externalUserId 时按邮箱预建客户；之后带相同已验证邮箱的 externalUserId 会就地认领它。
- 调用凭据
- 仅服务端 API Key。由可信后端调用。
- 所需权限
customers:write
base URL 和 App ID 来自 SDK 接入页。示例使用占位值，不会执行请求。服务端 Key 不可放入浏览器。
1curl -X POST "$GROOVE_BASE_URL/api/v1/customers" \2 -H "Authorization: Bearer $GROOVE_SECRET_KEY" \3 -H "X-Groove-Project: $GROOVE_PROJECT_ID" \4 -H "X-Groove-Environment: sandbox" \5 -H "Content-Type: application/json" \6 -d '{7 "externalUserId": "user_123",8 "name": "Alex",9 "email": "alex@example.com"10}'
响应为示例，不代表已实际执行请求。
请求参数
JSON 请求体
externalUserIdstring可选你服务端登录系统的稳定用户 ID；不是邮箱。按邮箱预建、尚未认领的客户为 null。
minLength: 1 · maxLength: 255
namestring可选客户或对象的展示名称，不作为身份唯一键。
maxLength: 80 · default: ""
emailemail | ""可选客户联系邮箱；不用于自动合并客户身份。
default: ""
attributesobject可选最多 128 个键，每键 1–128 字符，总 JSON ≤64 KiB；值可为嵌套 JSON，单值最多 20 层和 10,000 个节点。禁止保留字段；null 是属性值，删除使用 removeAttributes。标签保存在 attributes.tags，更新使用 tagChanges。
default: {}
fingerprintstring可选本次操作的 fingerprint 值，类型和约束见字段标注。
minLength: 1 · maxLength: 255
响应字段
成功响应包含 requestId 和 scope。结合实际业务状态或 accepted 判断操作结果；可选字段不可用时省略。
HTTP 200 · application/json
requestIduuid必填服务端生成的 HTTP 请求 UUID，排查请求时提供这个值。
scopeobject必填响应实际所属的 App 和环境。Header 只能核对，不能切换 Key 范围。
展开子字段
projectIdstring必填凭据绑定的 App ID。
minLength: 1
environmentenum必填独立数据范围：sandbox 或 live。
查看允许值
"sandbox""live"
customerobject必填客户资料对象。
展开子字段
iduuid必填本次操作的 id 值，类型和约束见字段标注。
externalUserIdstring | null必填你服务端登录系统的稳定用户 ID；不是邮箱。按邮箱预建、尚未认领的客户为 null。
namestring必填客户或对象的展示名称，不作为身份唯一键。
maxLength: 80
emailemail | ""必填客户联系邮箱；不用于自动合并客户身份。
attributesobject必填最多 128 个键，每键 1–128 字符，总 JSON ≤64 KiB；值可为嵌套 JSON，单值最多 20 层和 10,000 个节点。禁止保留字段；null 是属性值，删除使用 removeAttributes。标签保存在 attributes.tags，更新使用 tagChanges。
revisioninteger必填读取资料时返回的版本号；更新使用它检测并发修改。
min: 0 · max: 9007199254740991
createdAtdate-time必填记录创建时的 ISO 8601 UTC 时间。
updatedAtdate-time必填记录最后更新时的 ISO 8601 UTC 时间。
createdboolean必填本次操作的 created 值，类型和约束见字段标注。
处理错误
常见失败| 错误码 | 处理方式 |
|---|
| UNAUTHENTICATED | 核对 Key，或将过期客户 Token 重新签发一次。 |
| FORBIDDEN | 核对当前 Key 权限与客户访问范围。 |
| INVALID_REQUEST | 检查字段类型、UUID、十进制字符串和互斥字段。 |
| SCOPE_MISMATCH | 使用凭据绑定的 App 和环境。 |
常见失败
UNAUTHENTICATED
- 处理方式
- 核对 Key，或将过期客户 Token 重新签发一次。
FORBIDDEN
- 处理方式
- 核对当前 Key 权限与客户访问范围。
INVALID_REQUEST
- 处理方式
- 检查字段类型、UUID、十进制字符串和互斥字段。
SCOPE_MISMATCH
- 处理方式
- 使用凭据绑定的 App 和环境。
相关:完整请求与错误约定·返回接口索引