POST
/
v1
/
tenants
/
api-keys
curl --request POST \
  --url https://api.base39.io/v1/tenants/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "rules": "*",
  "email": "<string>",
  "name": "<string>",
  "allowedIps": [
    {
      "ip": "200.50.0.0/8",
      "description": "<string>"
    }
  ],
  "isFineGrained": true
}'
{
  "id": "key_6352a35384c95868100e226c",
  "value": "bs_live_63cae5a4d27a39cc28301544"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

​
base39-external-client-id
string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

Body

application/json

Criar chave da API

​
rules
required

Use esta opção caso seja necessária uma chave da api com permissão total (leitura e escrita) no sistema.

Available options:
*
Example:

"*"

​
email
string
required

Email do desenvolvedor responsável.

​
name
string
required

Nome do desenvolvedor responsável.

​
allowedIps
object[]
​
isFineGrained
boolean

Utilizado para ativar ou desativar o controle de acesso granular. Quando habilitado (true), é aplicado regras detalhadas definidas pelo autorizador para permitir ou negar acesso a recursos específicos com base em condições predefinidas.

Example:

true

Response

201 - application/json
Retorna o objeto `ApiKeyResponse` se a criação for bem-sucedida; senão, um erro para parâmetros inválidos.

Este objeto representa o retorno da criação de uma chave da API do seu negócio. Com ela você pode realizar requisições para a API do Base39.

​
id
string

Identificador exclusivo para o objeto.

Example:

"key_6352a35384c95868100e226c"

​
value
string

Este campo representa a chave necessária para autenticar e autorizar as requisições. Existem dois tipos de prefixos possíveis para esta chave: bs_sandbox_ e bs_live_. O prefixo bs_sandbox_ é usado para chaves associadas a tenants cujos nomes terminam com "-sandbox", enquanto o prefixo bs_live_ identifica chaves vinculadas a tenants que não terminam com "-sandbox". A escolha do prefixo determina o contexto e a finalidade da chave da API.

Example:

"bs_live_63cae5a4d27a39cc28301544"

Listar chaves da APIAtualizar chave da api