Skip to content

API keys

Operações relacionadas ao gerenciamento de API Keys

Operations

Cria uma API key v1

Request

Cria uma API key V1

Security
Authorization
Bodyapplication/jsonrequired
descriptionstringrequired
Example:"Minha chave de integração"
POST
/hub-api/api-keys
curl -i -X POST \
  https://api.producao.aprova.com.br/hub-api/api-keys \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Minha chave de integração"
  }'

Responses

Default Response

Bodyapplication/json
idstring
Example:"abc123"
secretKeystring
Example:"sk_live_xxx"
organizationCodenumber
Example:123
createdAtstring
Example:"2025-10-27T09:00:00Z"
descriptionstring
Example:"Chave API principal"
activeboolean
Example:true
Response
{
  "id": "abc123",
  "secretKey": "sk_live_xxx",
  "organizationCode": 123,
  "createdAt": "2025-10-27T09:00:00Z",
  "description": "Chave API principal",
  "active": true
}