Define o raio permitido (cerca virtual) do espaço de ponto
PUT/api/time-tracking/spaces/{spaceId}/geofence
- Auth
- Requires a token
- API key:
- No API key accepted
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
Owner e admin (os demais, 403 `geofenceDenied`); o espaço precisa estar ligado a um estabelecimento (409 `noEstablishment`). Um ponto (latitude e longitude; `address` é só o rótulo digitado), o raio em metros (10 a 50.000) e o modo: `BLOCK` recusa a marcação fora do raio ou sem localização (422 com `errors`, e a tentativa fica registrada para a gestão, sem virar marcação nem consumir NSR); `FLAG` grava a marcação com o selo "fora do raio" e a distância, visíveis no espelho e no CSV (nunca no AFD nem no AEJ). Sem cerca, tudo como antes: nada recusa a marcação. A responsabilidade pela regra é da empresa.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
spaceIdrequired | path | string (uuid) |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
| Name | Type | Description |
|---|---|---|
latituderequired | number | ≥ -90, ≤ 90 |
longituderequired | number | ≥ -180, ≤ 180 |
radiusMetersrequired | integer | ≥ 10, ≤ 50000 |
moderequired | BLOCK | FLAG | |
addressoptional | string | max 255 |
Responses
| Status | Description |
|---|---|
200 | O espaço, com `geofence`. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Só a gestão do ponto (owner, admin, financeiro): `timeTracking.errors.managementOnly`; quem não tem cadastro de empregado: `notEmployee`; sessão de suporte do SuperAdmin: `supportSession`. |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
422 | Dado inválido (CPF ou CNPJ com dígito errado, dia, período, campo obrigatório, pessoa sem acesso ao espaço, CPF do responsável ausente). |
curl example
curl -X PUT "https://api.memberfy.net/api/time-tracking/spaces/<spaceId>/geofence" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"latitude":10,"longitude":10,"radiusMeters":10,"mode":"BLOCK"}'