Cria uma chave de API pessoal
POST/api/integrations/api-keys
- Auth
- Exige token
- Quem pode:
- owner
- Chave de API:
- Não aceita chave de API
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
A equipe cria as próprias chaves; membro só com `memberApiKeysEnabled` ligado pelo owner (senão 403). No máximo 5 ativas por pessoa. Desligado, as chaves de membro já criadas respondem 403 (`apiKeys.auth.membersDisabled`) e voltam a funcionar quando o owner religa. O escopo é por módulo e nível (`GET /api/integrations/api-keys/modules`), padrão zero: sem nada marcado a chave é criada e responde 403 em toda rota que exige login. Os escopos não se editam depois: para mudar, crie outra chave.
A resposta traz `secret` (`mfk_<prefixo>_<segredo>`) **uma única vez**; depois só o `prefix`. Para usar: `X-Api-Key: <secret>` e `X-CommunityId` desta comunidade, sem `Authorization`. A permissão efetiva é escopo ∩ papel atual do dono.
Headers
| Nome | Tipo | Descrição |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo da requisição application/json
| Nome | Tipo | Descrição |
|---|---|---|
nameobrigatório | string | max 80 |
scopesopcional | string[] | `<módulo>:<nível>`. Desconhecido dá 422. |
expiresAtopcional | string (date-time) | Opcional; no futuro. Vencida |
allowedIpsopcional | string[] | IPv4 |
Respostas
| Código | Descrição |
|---|---|
201 | Chave criada; `secret` só aparece aqui. |
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. |
422 | Nome, escopo, IP ou validade inválidos, ou 5 chaves ativas já existem. |
Exemplo com curl
curl -X POST "https://api.memberfy.net/api/integrations/api-keys" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"name":"string"}'