Skip to content

Chegada de um visitante (público, com token)

POST/api/attendance/kiosk/check-in

Auth
Requires a token
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

Abre a visita do visitante (método `KIOSK`). `guestName` é obrigatório; `guestCompany` e `guestPhone` valem conforme `guestFields` da sessão (`required` exige, `off` ignora). `hostProfileId` precisa ser um membro da comunidade **do token** com acesso ao space (senão 404). O corpo nunca aceita `communityId` nem `spaceId`. **Idempotente** por nome normalizado + anfitrião + space: o segundo pedido devolve a visita aberta (`200`, `alreadyCheckedIn: true`). Cria: `201`. Se o space tem `notifyHost`, o e-mail ao anfitrião vai para a fila (nunca na requisição), com teto de 10 por hora por anfitrião; passando do teto a visita é registrada e o e-mail não sai. Limite: 10 por minuto por token.

Headers

NameTypeDescription
X-Kiosk-TokenrequiredstringToken do quiosque. A comunidade e o space saem dele; nunca vão no corpo nem no caminho.

Request body application/json

NameTypeDescription
guestNamerequiredstringmax 100
guestCompanyoptionalstringmax 100
guestPhoneoptionalstringmax 30
hostProfileIdrequiredstring (uuid)

Responses

StatusDescription
200Já havia visita aberta deste visitante com este anfitrião.
201Visita aberta.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou revogado, ou space apagado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
429Limite de taxa (por token e por IP). Traz `Retry-After` (segundos) e `errors`.
500Erro interno do servidor.

curl example

curl -X POST "https://api.memberfy.net/api/attendance/kiosk/check-in" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"guestName":"Maria Souza","hostProfileId":"00000000-0000-0000-0000-000000000000"}'