Aller au contenu

Cria ou executa domain

POST/api/communities/domain

Auth
Public
Clé d’API:
community: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.

Autenticação opcional: o conteúdo retornado varia conforme o membro autenticado. `data.ownerContact` (`{ name, email }`, ou `null` se a comunidade não tem owner) é o contato que os e-mails da comunidade imprimem no rodapé ("Dúvidas? Fale com…"), o mesmo valor do envio. Só vem para a equipe (owner, admin, moderador, financeiro) e para o SuperAdmin; para membro comum e anônimo o campo não aparece. `data.dropsInComments` (boolean, para todos) diz se a comunidade aceita Drops nos comentários: desligado, o app esconde o botão de gravar no comentário. `data.canUseApiKeys` (boolean) diz se quem chama pode ter chaves de API pessoais nesta comunidade (o menu "Integrações & APIs"): a equipe sempre pode; membro só com `memberApiKeysEnabled` ligado pelo owner; `false` sem login. `data.memberApiKeysEnabled` só vem para a equipe. `data.webApp` (para todos) é o que o `/site.webmanifest` do app precisa para a comunidade instalada na tela de início: `{ name, shortName, themeColor, backgroundColor, icons }`. `icons` são PNG 192 e 512, `purpose` `any` (o logo sobre branco) e `maskable` (o logo na zona segura, sobre a cor da comunidade), feitos a partir do logo pela fila; vazio até ficarem prontos ou sem logo (o app usa os ícones dele). Trocar o logo refaz os ícones sozinho. Exemplo: `{ "name": "Comunidade Dev SP", "shortName": "Comunidade", "themeColor": "#db2777", "backgroundColor": "#ffffff", "icons": [{ "src": "https://media.memberfy.net/communities/…/icon-192.png", "sizes": "192x192", "type": "image/png", "purpose": "any" }] }`.

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
domainfacultatifstringValid domain is required

Réponses

StatutDescription
201Operação realizada com sucesso.
400Requisição inválida — falha de validação.
500Erro interno do servidor.

Exemple curl

curl -X POST "https://api.memberfy.net/api/communities/domain" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'