Adiciona ou troca o domínio próprio
PUT/api/communities/custom-domain
- Auth
- Requiere token
- Quién puede:
- SuperAdmin
- Clave de API:
- community:write
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Owner e admin (e o SuperAdmin em sessão de suporte). Registra `hostname` na hospedagem na hora e devolve o registro DNS a criar; um job confere DNS, certificado e HTTPS (a cada 1 min nos primeiros 10, depois a cada 5) até ficar ativo ou expirar em 7 dias (sai da hospedagem e o owner é avisado por e-mail). Com um domínio ativo, um hostname novo é uma **troca sem queda**: o antigo continua no ar até o novo ficar ativo. Mandar o hostname do ativo desiste da troca; mandar outro no lugar de um pendente o substitui. O owner recebe e-mail quando fica ativo, quando falha e quando expira. Aceita subdomínio (CNAME) e domínio raiz (ALIAS/ANAME). Recusas (com `param` = hostname): 400 `customDomain.invalidFormat`, `customDomain.localOrIp` (localhost, nome local ou IP), `customDomain.platformDomain` (memberfy.net, memberfy.dev e domínios da hospedagem); 403 `customDomain.notEntitled` (o plano não inclui); 409 `customDomain.takenByCommunity` (outra comunidade usa ou pediu), `customDomain.inUseElsewhere` (em uso fora da Memberfy, ou já na hospedagem sem ser desta comunidade), `customDomain.previouslyUsed` (outra comunidade já usou o domínio; só o SuperAdmin o passa adiante), `customDomain.subdomainMissing`; 502 `customDomain.providerUnavailable`.
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
If-Unmodified-Sinceopcional | string | Opcional: a versão lida (`settingsUpdatedAt` de `GET /api/communities/settings` ou da última gravação (uma versão só para a linha da comunidade: perfil, marca, imagens, diretório, remetentes das automações e domínio)), como data HTTP, se não vier `settingsUpdatedAt` no corpo. Outra gravação depois dela responde 409. |
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Cuerpo de la solicitud application/json
| Nombre | Tipo | Descripción |
|---|---|---|
hostnameobligatorio | string | O domínio, sem https:// (um https:// colado é aceito). · max 64 |
Respuestas
| Código | Descripción |
|---|---|
200 | O endereço da comunidade, com o pedido novo em `pending`. |
400 | Requisição inválida — falha de validação. |
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 | Conflito com o estado atual do recurso. |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X PUT "https://api.memberfy.net/api/communities/custom-domain" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"hostname":"string"}'