POSTWebhooks & API Keys

Criar chave de API

Cria uma chave sk_ com escopos. A chave completa é retornada em claro UMA vez (guarde-a).

POST/api-keys
AutenticaçãoPainel admin

Cookie de sessão do painel (ecom_token) + permissão RBAC.

Corpo da requisição

  • nomestringobrigatório

    Nome/descrição da chave.

  • scopesarrayopcional

    Escopos (ex.: orders:read, products:read).

Cabeçalhos

  • Cookiestringobrigatório

    Cookie de sessão do painel: ecom_token=<jwt> (obtido em POST /auth/login).

Requisição

curl -X POST "https://api.ecomplataforma.com.br/api-keys" \
  -b cookies.txt -H "Content-Type: application/json" \
  -d '{"nome":"Integração ERP","scopes":["orders:read","products:read"]}'

Resposta201

200 OK
{ "success": true, "data": { "id": "ak_2", "key": "sk_live_..." } }

Respostas de erro

401Não autenticado
401 Não autenticado
{
  "success": false,
  "error": "Sessão ausente ou expirada."
}
403Sem permissão
403 Sem permissão
{
  "success": false,
  "error": "Você não tem permissão para acessar este recurso."
}
422Falha de validação
422 Falha de validação
{
  "success": false,
  "error": "O campo 'email' é obrigatório."
}