ApiKey

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

idstring

Identificador exclusivo para o objeto.

Example: key_6352a35384c95868100e226c

rules object

oneOf

MOD1

string

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

Possible values: [*]

Example: *

MOD2

Array [

resourcestringrequired

Caminho base que define o recurso permitido.

Possible values: Value must match regular expression (^\/v[1-9]\/.{3,}|\*)

rulestringrequired

Regra que será aplicada ao recurso descrito anteriormente.

Possible values: [readOnly, readWrite, writeOnly]

Example: readOnly

conditions object[]

Condições que serão aplicadas ao recurso descrito anteriormente.

Array [

fieldstringrequired

Campo que será validado.

searchInstringrequired

Local em que o campo será procurado.

Possible values: [body, header, query]

allowedValuesstring[]required

Valor que será comparado com o campo.

]

]

emailstring

Email do desenvolvedor responsável.

namestring

Nome do desenvolvedor responsável.

isFineGrainedboolean

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[]

Array [

ipstringrequired

IPv4 ou CIDR habilitado para utilizar a api-key.

Example: 200.50.0.0/8

descriptionstringrequired

Campo para descrever qual o sistema do referido IPv4 ou CIDR.

]

revokedIndate

Data de quando a api-key foi revogada.

apiKeystring

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

Example: ****************************1544

createdBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

ApiKey

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