ApiKey

Este objeto representa alguns dados chave da API do seu negócio. Com ela você pode realizar requisições às APIs da Base39.

string

Identificador exclusivo para o objeto.

Example:

"key_6352a35384c95868100e226c"

rules

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

Available options:

*

Example:

"*"

string

Email do desenvolvedor responsável.

name

string

Nome do desenvolvedor responsável.

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

allowedIps

object[]

revokedIn

string

Data de quando a api-key foi revogada.

apiKey

string

Chave da API ofuscada, apresentando apenas os últimos 4 caracteres.

Example:

"****************************1544"

createdBy

object

updatedBy

object

ApiKeys ApiKeyResponseCreate

{
  "id": "key_6352a35384c95868100e226c",
  "rules": "*",
  "email": "<string>",
  "name": "<string>",
  "isFineGrained": true,
  "allowedIps": [
    {
      "ip": "200.50.0.0/8",
      "description": "<string>"
    }
  ],
  "revokedIn": "2023-12-25",
  "apiKey": "****************************1544",
  "createdBy": {
    "clientId": "client_identifier",
    "externalClientId": "<string>",
    "app": "backoffice"
  },
  "updatedBy": {
    "clientId": "client_identifier",
    "externalClientId": "<string>",
    "app": "backoffice"
  }
}

Empréstimos

Empresas

Clientes

Fundos

Eventos

Cobrança

Arquivos

Configurações

Entidades

Automações

Modelos