Aller au contenu

Atualiza a configuração de gamificação

PUT/api/gamification/config

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
Clé d’API:
gamification:write
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Exige owner ou admin da comunidade do `X-CommunityId`. `isEnabled` liga ou desliga o Engajamento; `actionRules` mapeia o tipo de ação para os pontos que ela vale (`{ "CREATE_POST": 10 }`) — os tipos que ficam de fora mantêm a pontuação atual. As mensagens de resposta e de validação vêm no idioma do `Accept-Language`.

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corps de la requête application/json

NomTypeDescription
isEnabledfacultatifbooleanLiga ou desliga a gamificação na comunidade.
dailyCapsfacultatifobjectO "máximo por dia por pessoa" de cada ação (1 a 10.000; `null` tira o teto). Acima do teto, no dia da comunidade, a ação acontece mas não dá pontos nem conta para as regras de badge; o registro fica com `capped: true` ("teto atingido"). Tipo desconhecido ou valor fora da faixa → 400. As respostas trazem `dailyCap` (ou `null`) em cada ação de `actionRules`.
actionRulesfacultatifobjectPontos por tipo de ação (CREATE_POST, LIKE_POST, COMMENT_POST, REPLY_COMMENT, RECEIVE_LIKE, CREATE_EVENT, PARTICIPATE_EVENT, CREATE_COURSE, ENROLL_COURSE, COMPLETE_LESSON, DAILY_LOGIN, GIVE_RECOGNITION, RECEIVE_RECOGNITION). As duas de reconhecimento começam em 0 (quem reconhece e cada pessoa reconhecida), e apagar o reconhecimento devolve os pontos.

Réponses

StatutDescription
200Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token 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`).
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

Exemple curl

curl -X PUT "https://api.memberfy.net/api/gamification/config" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'