Skip to main content
POST
/
api-key
curl --request POST \
  --url https://api.example.com/api-key \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Pontua Bot — POC integração",
  "expiresIn": "7d",
  "permissions": [
    "read"
  ]
}
'
{
  "status": true,
  "mensagem": "OK"
}

Body

application/json

Nome, permissões e prazo de expiração da chave a ser criada

​
name
string
required

Nome amigável da chave para identificação no inventário. Use algo descritivo do propósito da integração — ex.: "Sync ERP Domínio - Producao", "Bot relatorio mensal contabilidade".

Example:

"Sync ERP Domínio - Produção"

​
permissions
enum<string>[]
required

Permissões concedidas à chave. Aplique o princípio de menor privilégio — conceda apenas o necessário. read = GETs. write = POSTs. update = PATCH/PUT. delete = DELETEs.

Available options:
read,
write,
update,
delete
Example:
["read", "write"]
​
expiresIn
enum<string>
default:7d
required

Período de validade da chave. Após expiresAt, todas as chamadas falham com 401 sem possibilidade de reativação. Para integrações de produção, prefira 1y com rotação automatizada. Evite 5y exceto em ambientes on-premises auditados.

Available options:
7d,
30d,
45d,
90d,
180d,
1y,
5y
Example:

"1y"

Response

Chave criada — o campo message contém o token bruto (mostrado apenas aqui)

​
status
boolean
required

Status da operação

Example:

true

​
mensagem
string

Mensagem de retorno

Example:

"OK"