Pular para o conteúdo principal

POST /api/v1/analytics/identify/public

Vincula um anonymousId a um userId e persiste traits (atributos) do usuário. Versão pública do /identify, autenticada por API Key — pode ser chamada do browser ou app móvel.

Autenticação

API Key.

Headers

HeaderValor
AuthorizationBearer <sua-key>
Content-Typeapplication/json

Body

CampoTipoObrigatórioDescrição
anonymousIdstringSimIdentificador anônimo do visitante
userIdstring | nullNãoID do usuário autenticado a vincular ao anonymousId
sessionIdUUIDNãoSessão atual; se omitida, resolvida automaticamente
traitsobjectNãoAtributos do usuário (email, firstName, plan, ...)
contextSegmentContextNãoContexto de ambiente

Se você enviar anonymousId sem userId, o endpoint apenas registra os traits no perfil anônimo. Para criar o vínculo identidade → usuário, envie userId.

Exemplo de requisição

curl -X POST https://api-crm.ecommerceapp.com.br/api/v1/analytics/identify/public \
-H "Authorization: Bearer SUA-KEY" \
-H "Content-Type: application/json" \
-d '{
"anonymousId": "anon-7c1f3a",
"userId": "user-9182"
}'

Resposta

200 OK

{
"success": true,
"session": {
"sessionId": "01J9XK8E7G5R3M2N4P6Q8S0T1V",
"isNew": false
}
}

Quando chamar

  • Imediatamente após login bem-sucedido do usuário.
  • Após cadastro (sign-up).

Erros

StatusCausa
400 Bad RequestBody inválido
401 UnauthorizedAPI Key inválida ou ausente