Lista os tipos de reconhecimento da comunidade, com a arte de cada um
GET/api/recognitions/types
- Auth
- Exige token
- Chave de API:
- Não aceita chave de API
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
Qualquer papel que abra um espaço de Reconhecimento (ou `spaceId`), como `GET /values`: o membro precisa dos tipos na grade do "Reconhecer". Vêm sempre os 7 tipos, na ordem de exibição, ligados ou não (a grade mostra só os ligados; as configurações, todos). Valem para todos os espaços de Reconhecimento da comunidade. `label` é o rótulo do tipo (a grade); `phrase`, a frase que vai na faixa sobre a arte, no Cartão e no e-mail, no idioma do `Accept-Language`. `artUrl` já vem resolvido: a arte própria da comunidade (`hasCustomArt: true`) ou a padrão, uma ilustração 3:1 (WebP, cerca de 2000×667) feita pela Memberfy, com o motivo à direita e a metade esquerda livre para o texto, igual para todas as comunidades. Pública; muda de endereço quando o arquivo da Memberfy muda.
Parâmetros
| Nome | Onde | Tipo | Descrição |
|---|---|---|---|
spaceIdopcional | query | string (uuid) | Um espaço de Reconhecimento; sem ele, basta abrir algum. |
Headers
| Nome | Tipo | Descrição |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Respostas
| Código | Descrição |
|---|---|
200 | Os 7 tipos. |
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 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
Exemplo com curl
curl -X GET "https://api.memberfy.net/api/recognitions/types" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"