2.1. Configurações Disponiveis¶

Existem algumas configurações que podem ser facilmente customizadas e adicionadas às configurações

2.1.1. API¶

API key can be a dictionary in case it is just a single API or a list of dictionaries in case it is multiple APIs “

AUTHENTICATION_ACCESS_TOKEN

Nota

Definição: Usado para passar o Token de Acesso da sua API
Padrão: None
Requerido: True

AUTHENTICATION_ACCESS_TOKEN_TYPE

Nota

Definição: Chave usada no Header Authorization. Pode ser Bearer, Token, etc
Padrão: ‘Bearer’
Requerido: False

AUTHENTICATION_METHOD

Nota

Definição: Método utilizado para autenticação. Hoje apenas header e url usando parâmetros estão disponíveis
Padrão: ‘header’
Requerido: False

AUTHENTICATION_URL_EXTRA_PARAMS

Nota

Definição: Parâmetros extras usados para autenticar por URL usando o método GET
Padrão: []
Requerido: False

AUTHENTICATION_URL_KEY

Nota

Definição: Chave usada para autenticar por URL usando o método GET
Padrão: ‘token’
Requerido: False

BASE_URL

Nota

Definição: URL da API com o protocolo. Ex: https://example.com/v1
Padrão: None
Requerido: True

ENDPOINTS

Nota

Definição: Usado para mapear todos endpoints que você quer acessar
Padrão: []
Requerido: False

LOCALE

Nota

Definição: Disponível apenas no método de autenticação header, é usado para passar o Accept-Language na solicitação
Padrão: Linguagem padrão do codigo setada no settings.py
Requerido: False

NAME

Nota

Definição: Apelido usado para instaciar o cliente da API
Padrão: None
Requerido: False

URL_APPEND_SLASH

Nota

Definição: Adiciona uma / no fim da URL do endpoint
Padrão: True
Requerido: False

TIMEOUT

Nota

Definição: Período de espera pela resposta da requisição
Padrão: 3
Requerido: False

2.1.2. Configuração padrão¶

PAGE_SIZE

Nota

Definição: Usado para definir o tamanho da Paginação
Padrão: 100
Requerido: False

SLUG_FIELD

Nota

Definição: Change usada para pegar um registro de um endpoint. Use o mesmo identificadorque você recebe no payload
Padrão: ‘id’
Requerido: False