Skip to content
memberfy
US

Cria uma chave de API pessoal

POST/api/integrations/api-keys

Auth
Requires a token
Who can call it:
owner
API key:
No API key accepted
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

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

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

Request body application/json

NameTypeDescription
namerequiredstringmax 80
scopesoptionalstring[]`<módulo>:<nível>`. Desconhecido dá 422.
expiresAtoptionalstring (date-time)Opcional; no futuro. Vencida
allowedIpsoptionalstring[]IPv4

Responses

StatusDescription
201Chave criada; `secret` só aparece aqui.
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.
422Nome, escopo, IP ou validade inválidos, ou 5 chaves ativas já existem.

curl example

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"}'