Cria um badge
POST/api/badges
- Auth
- Richiede un token
- Chi può:
- owner
- admin
- Chiave API:
- gamification:write
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
Só owner e admin. `imageUrl` obrigatório, de uma imagem enviada antes em `POST /api/badges/image` desta mesma comunidade (outra URL: 422 em `imageUrl`). Nome obrigatório, até 60 caracteres, único na comunidade entre os badges vivos, sem diferenciar maiúsculas (repetido: **409** em `name`). Descrição até 300. `visibility` `public` (padrão) ou `private`. Erros de campo: **422** com o `param`.
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
| Nome | Tipo | Descrizione |
|---|---|---|
nameobbligatorio | string | max 60 |
descriptionfacoltativo | string | max 300 |
imageUrlobbligatorio | string | |
visibilityfacoltativo | public | private | |
rulefacoltativo | object | Opcional. Campo inválido → 422 com `errors[].param` (`rule.trigger`, `rule.minCount`, `rule.spaceId`, `rule.window`, `rule.minMemberDays`); passar de 50 regras na comunidade → 400 (`badges.ruleLimit`). |
Risposte
| Codice | Descrizione |
|---|---|
201 | Criado. |
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. |
409 | Já existe um badge com este nome na comunidade. |
422 | Campo inválido (nome, descrição, imagem ou visibilidade). |
Esempio con curl
curl -X POST "https://api.memberfy.net/api/badges" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"name":"string","imageUrl":"string"}'