HumanTrackDevelopers

Vínculo de conta

Como vincular à sua plataforma um profissional que já tem conta na HumanTrack, e como desfazer o vínculo.

Um profissional que já usa a HumanTrack pode ser vinculado à sua plataforma. O vínculo depende da confirmação do próprio profissional, feita a partir de um e-mail de verificação.

Sequência do vínculo de conta: verificação, pedido de vínculo e confirmação do profissional

Em texto: a sua plataforma consulta GET /professionals/check para saber se o profissional existe e se já está vinculado a você, e então chama POST /connect com o e-mail e o external_id. Se o vínculo já está ativo, a resposta é 200 ALREADY_LINKED. Se o pedido é aceito, a resposta é 202 VERIFICATION_LINK_SENT e a HumanTrack envia, de forma assíncrona, o e-mail de verificação ao profissional; a resposta não garante que o e-mail foi entregue. O vínculo só fica ativo depois que o profissional confirma, e uma nova consulta a GET /professionals/check passa a trazer linked: true.

1. Verificar se o profissional existe

GET /professionals/check?email=... informa se existe um profissional com aquele e-mail e se ele já está vinculado a você.

2. Solicitar o vínculo

POST /connect solicita o vínculo de um profissional existente à sua plataforma. O corpo informa o e-mail do profissional na HumanTrack e o identificador dele na sua plataforma:

{
  "email": "profissional@example.com",
  "external_id": "prof-123"
}

A HumanTrack envia um e-mail de verificação ao profissional. As respostas possíveis:

CódigoSignificado
202VERIFICATION_LINK_SENT: e-mail de verificação enviado (inclusive no reenvio de um pedido pendente).
200ALREADY_LINKED: o vínculo já está ativo.
401Não autorizado.
404Profissional não encontrado.

O identificador informado em external_id é o que aparece como externalProfessionalId nos webhooks.

3. Desfazer o vínculo

POST /disconnect/{professionalId} desconecta o profissional da sua plataforma: o status da integração passa de ACTIVE para INACTIVE.

Efeito nos webhooks

Enquanto a integração com o profissional estiver inativa, você não recebe eventos das aplicações dele, inclusive das aplicações que você criou. Reconectando, volta a receber. Veja quais aplicações geram eventos.

Os detalhes de cada endpoint estão na Referência da API.

Nesta página