Usuários do Widget

A API de Usuários do Widget permite autenticar usuários e gerar tokens de acesso para a aplicação de widget, que permite o usuário conectar sua conta de forma segura.

POST/v1/widgets/users/sign-in

Autenticar Usuário

Este endpoint recebe as informações do usuário e retorna uma URL de redirecionamento para a aplicação de login.

Corpo da Requisição

Name
widget_uid
Type
string
Required
obrigatório
Description
UID do widget ao qual o usuário será vinculado. Deve pertencer à organização da chave de API.
Name
external_uid
Type
string
Required
obrigatório
Description
Identificador único externo do usuário no seu sistema.
Name
tax_id
Type
string
Description
CPF do usuário.
Name
phone
Type
string
Description
Número de telefone do usuário no formato E.164. Quando informado, deve ser um número válido e verificado pela plataforma.

Request

POST

/v1/widgets/users/sign-in

curl -X POST https://api.habilitar.me/v1/widgets/users/sign-in \
  -H "Content-Type: application/json" \
  -H "x-api-key: {api_key}" \
  -d '{
    "widget_uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "external_uid": "user_12345",
    "tax_id": "12345678901",
    "phone": "+5511999999999"
  }'

Response

{
  "redirect_url": "https://login.habilitar.me/w/a1b2c3d4-e5f6-7890-abcd-ef1234567890/auth/aBcDeFgHiJkLmNoPqRsTuVwXyZ012345"
}

Response - 400

{
  "error": "Bad Request",
  "message": "external_uid is required"
}

Response - 400 (tax_id inválido)

{
  "error": "Bad Request",
  "message": "tax_id must be a valid Brazilian CPF"
}

Response - 400 (phone inválido)

{
  "error": "Bad Request",
  "message": "phone must be a valid phone number, must be prefixed with '+' (E.164 format)"
}

Response - 404

{
  "error": "Not Found",
  "message": "Widget not found or does not belong to this organization"
}

Response - 409 (tax_id divergente)

{
  "error": "Conflict",
  "message": "The provided tax_id does not match the tax_id registered for this user"
}