Entrar

Criar convite

GET https://{organization}.myguper.com/api/register/person/invite/{idPerson}

Emite um token de convite para uma pessoa existente, para que ela possa depois criar credenciais de login no Connect. Este é o primeiro passo do fluxo de onboarding de usuário:

  1. A pessoa já existe no Register (criada via Criar Pessoa ou importada de um feed de clientes).
  2. Um admin chama este endpoint com o idPerson da pessoa e recebe um inviteToken.
  3. O token é entregue ao novo usuário (link de e-mail, magic link, QR code, etc.).
  4. O usuário envia o token + login e password escolhidos para Connect · Criar usuário.
  5. O Connect descriptografa o token, valida organização + personId e grava o registro de User.

O token é URL-encoded (cabe em querystring) e criptografado em RSA com a chave pública do Connect — só o Connect consegue descriptografá-lo, e apenas para a organização em que foi emitido. É de uso único: depois que um User é criado, o token não pode ser resgatado de novo.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

Send your user token in the x-guper-authorization header.

Cabeçalhos

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Parâmetros do caminho

Name Type Description
idPerson * integer Internal Guper person ID (returned by [Create Person](/docs/{lang}/api-reference/register/person/create) or any feed/lookup endpoint).

Respostas

{
    "inviteToken": "MAjLGiKVeKFG97TaYTDwmcEgOvrICbdAgo7t%2BytNC%2FV6hJ3fSBKbLh%2F7Oju3wHli4ELaOUH0AsyWlEs%2B4hzccAZmhnG0mmLmayN2VZCQmLZbLSYVwOfW14xJ9nof5LWmHWLeazwby%2BJuYkei8Poh04Eune00pIHAvWU6Vlr3Rbk%3D",
    "dateTime":    "2026-05-01T12:34:56-03:00"
}

Relacionados

Copied to clipboard