Zum Inhalt springen

O que o plano da comunidade libera e o uso

GET/api/entitlements/community

Auth
Token erforderlich
API-Schlüssel:
community:read
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

Owner e admin da comunidade do `X-CommunityId`. Os valores efetivos (padrão global → plano → adicionais → exceção do SuperAdmin), de onde veio cada um, o plano da Memberfy em que a comunidade está, quantos membros conta e o percentual do teto, e quais extensões estão travadas. O motivo de uma exceção do SuperAdmin nunca aparece aqui.

O teto avisa e nunca barra: em 90 % e em 100 % o owner recebe um e-mail por período do plano.

Header

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

Antworten

StatusBeschreibung
200Valores e uso.
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.

curl-Beispiel

curl -X GET "https://api.memberfy.net/api/entitlements/community" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"