Access

Validar link de cadastro

Endpoint publico consumido pelo formulario de cadastro ao abrir um link de convite. Devolve a identidade visual e a configuracao do espaco, de modo que o formulario ja carrega personalizado.

A URL entregue ao visitante tem o formato https://<origem>/register/{slug-do-espaco}/{token}. O token tem 32 caracteres no padrao ^[A-Za-z0-9]{32}$.

O espaco e derivado do proprio token — o slug presente na URL e apenas informativo.

get/api/v1/access-links/validate/{token}

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/v1/access-links/validate/{token}
  • Auth: none declared

Path parameters

tokenstring required

Response

Link valido

validtrue required
linkType'permanent' | 'temporary' | 'single_use' | 'invitation' required

Natureza do link. invitation e o link de visitante criado por um morador/colaborador para um convidado.

accessType'permanent' | 'temporary' | 'single_use' required

Tipo de acesso concedido a quem se cadastrar pelo link.

prefillDataobject required

Dados que serao mesclados ao cadastro criado a partir do link.

validFromstring date-time nullable required
validUntilstring date-time nullable required

Example response

{
  "allowedHours": {
    "start": "07:00",
    "end": "19:00",
    "days": [
      1,
      2,
      3,
      4,
      5
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.