2.1. Available Settings

There are some settings that can be easily customized and added to the settings

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

Note

  • Definition: Used to pass your API Access Token

  • Default: None

  • Required: True

  • AUTHENTICATION_ACCESS_TOKEN_TYPE

Note

  • Definition: Key used on the Header Authorization. Could be Bearer, Token, etc

  • Default: ‘Bearer’

  • Required: False

  • AUTHENTICATION_METHOD

Note

  • Definition: Method used to authentication. Today only header and url using params is available

  • Default: ‘header’

  • Required: False

  • AUTHENTICATION_URL_EXTRA_PARAMS

Note

  • Definition: Extra params used to authenticate by URL using GET method

  • Default: []

  • Required: False

  • AUTHENTICATION_URL_KEY

Note

  • Definition: Key used to authenticate by URL using GET method

  • Default: ‘token’

  • Required: False

  • BASE_URL

Note

  • ENDPOINTS

Note

  • Definition: Used to map all endpoint you want to access

  • Default: []

  • Required: False

  • LOCALE

Note

  • Definition: Only available in the Header authentication method, is the used to pass the Accept-Language in the request

  • Default: Project Language Code set on settings.py

  • Required: False

  • NAME

Note

  • Definition: Slug Name used to instantiate the client api factory

  • Default: None

  • Required: False

  • URL_APPEND_SLASH

Note

  • Definition: Add a slash in end of the endpoint URL

  • Default: True

  • Required: False

  • TIMEOUT

Note

  • Definition: Period to wait for the request response

  • Default: 3

  • Required: False

2.1.2. General defaults

  • PAGE_SIZE

Note

  • Definition: Used to define the size of the Pagination

  • Default: 100

  • Required: False

  • SLUG_FIELD

Note

  • Definition: Key used to get a endpoint record. Use the same identifier you receive in payload.

  • Default: ‘id’

  • Required: False