POST Criar API Key
Cria uma API key da clínica com as permissões informadas. A chave completa (plainKey) é devolvida só nesta resposta — guarde-a, ela é usada no header x-api-key.
Envie o header Authorization: Bearer {accessToken} (token de usuário). Veja Autenticação.
Com x-api-key a resposta é 403: a rota depende do usuário do token.
Exige a permissão update_roles.
As chaves são emitidas e validadas pelo provedor de identidade (WorkOS) e pertencem à clínica do token. O valor completo não fica guardado: só aparece na criação.
As permissões da chave precisam existir no catálogo e ser permissões que o próprio usuário que cria já tem: ninguém emite chave com mais poder do que possui.
Não há como revelar a chave depois nem editar as permissões dela. Para mudar, crie uma chave nova e revogue a antiga.
Endpoint
POST https://api-dev.imagemais.com.br/api/api-keys
Corpo da Requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | ✅ | Nome de identificação (1 a 255 caracteres) |
permissions | string[] | ❌ | Slugs das permissões da chave, sem repetição (ex.: read_patients). Omitido: chave sem permissões |
Requisição
curl -X 'POST' \n 'https://api-dev.imagemais.com.br/api/api-keys' \n -H 'accept: application/json' \n -H 'Authorization: Bearer {accessToken}' \n -H 'Content-Type: application/json' \n -d '{
"name": "Integração Feegow",
"permissions": [
"read_patients",
"read_appointments"
]
}'
Respostas
201 Sucesso
{
"id": "api_key_01HXXXXXXXXXXXXXXXXXXXXXXX",
"name": "Integração Feegow",
"obfuscatedValue": "sk_live_...a1b2",
"permissions": [
"read_patients",
"read_appointments"
],
"createdAt": "2026-10-09T13:20:00.000Z",
"lastUsedAt": null,
"plainKey": "sk_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
400 Requisição inválida
Validação do corpo, Permissões inexistentes: {lista} (fora do catálogo) ou o aviso de clínica não migrada.
{
"message": "Permissões inexistentes: foo_bar",
"error": "Bad Request",
"statusCode": 400
}
403 Sem permissão
Mensagens possíveis: Permissões insuficientes, Você não tem estas permissões para dar à API key: {lista} e API keys só podem ser geridas por um usuário logado. (chamada feita com x-api-key).
{
"message": "Você não tem estas permissões para dar à API key: delete_users",
"error": "Forbidden",
"statusCode": 403
}
503 Serviço de login indisponível
{
"message": "Não foi possível falar com o serviço de login. Tente novamente em instantes.",
"error": "Service Unavailable",
"statusCode": 503
}