Access

Criar link de cadastro

Cria um link de cadastro para o espaco. Use linkType: "invitation" para links de visitante.

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}$.

Requer sessao autenticada com papel moderator ou admin. Um moderador so pode criar links para espacos aos quais esta atribuido; um administrador pode informar qualquer tenantId.

Comportamento atual: maxUses e single_use nao sao aplicados no cadastro pelo formulario publico — POST /clients/register aceita o token sem revalidar e sem incrementar currentUses. O limite so e respeitado em POST /access-links/enroll e POST /clients/enroll-by-cpf. Da mesma forma, targetDevices, allowedHours, validFrom e validUntil sao aceitos, gravados e devolvidos, porem nao restringem o acesso.

post/api/v1/access-links

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/v1/access-links
  • Auth: API key in cookie better-auth.session_token

Request body

tenantIdstring uuid

Espaco alvo. Sem valor, usa o espaco do usuario autenticado.

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.

validFromstring
validUntilstring
maxUsesinteger

Padrao 1.

targetDevicesstring[]
prefillDataobject

Dados mesclados ao cadastro criado a partir do link.

expiresAtstring

Example request

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

Response

Link criado

tokenstring required

Example response

{
  "link": {
    "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.