Abrir o rosto escolhido no e-mail do Pulso de humor
GET/api/surveys/mood-pulse/link/{token}
- Auth
- Requiere token
- Clave de API:
- surveys:read
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
Quem recebeu o e-mail, logado na comunidade. Cada rosto do e-mail abre o app com `?pulse=<token>&value=<1..5>`; esta rota diz qual rodada abrir. O rosto fica no app: ele lê `value` do próprio endereço e o deixa marcado (entre `minValue` e `maxValue`); o servidor não recebe a escolha. Não responde nada: a pessoa confirma e a resposta vai por `POST /api/surveys/{id}/responses`. O token é da pessoa e da rodada (sem identificar a pessoa em claro) e vale até a rodada encerrar (depois, `status: closed`). Token de outra pessoa ou alterado: 403 `moodPulseLinkNotYours`; malformado ou de outra comunidade: 404. A rota não deixa registro de acesso.
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
tokenobligatorio | path | string |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Respuestas
| Código | Descripción |
|---|---|
200 | A rodada e o rosto. |
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 | O link é de outra pessoa ou foi alterado (`moodPulseLinkNotYours`). |
404 | Link inválido (`moodPulseLinkInvalid`). |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X GET "https://api.memberfy.net/api/surveys/mood-pulse/link/<token>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"