Oz API Configuration

The configuration settings are contained in the config.py file.

Initial configuration

These parameters are mandatory. Please note: if you require the Instant API mode (with no data saved anywhere), set OZ_APP_COMPONENTS=stateless. Otherwise, to save data for orders and analyses, set OZ_APP_COMPONENTS=auth,stateful,oz_collections, where:

• auth is an authentication module,

• stateful is a module for full API,

• oz_collections is a module for the blacklist analysis (remove if you don't use it).

# application components list
OZ_APP_COMPONENTS=auth,stateful,oz_collections
# enable local storage support
OZ_LOCAL_STORAGE_SUPPORT_ENABLE=false
# tfss service host
OZ_SERVICE_TFSS_HOST=http://xxx.xxx.xxx.xxx:xxxx
# allowed hosts
APP_ALLOWED_HOSTS=example-host1.com,example-host2.com
# secret key
OZ_API_SECRET_KEY=long_secret_key

Postgres connection

This is needed only if you use the full API version.

DB_USER = 'user name'
DB_HOST = 'Postgres server address'
DB_PASS = 'user password'
DB_NAME = 'database name'

Path to media files

All incoming media files are saved in the local directory mounted to one of possible endpoints depending of the installation method:

• host server or Docker container: /opt/gateway/static

• in case of standalone installer: /var/lib/docker/volumes/api_oz-api-static-vol/_data

• any path specified via configuration

In most of the integration cases, the media files can be accessed in web using the direct links to randomly generated filenames.

To access the media, you need to specify in the configuration file their external host name or IP address, port, and connection protocol.

PORT = 443
SCHEME = 'https'
HOST = 'api.globalbank.com'

Connection to Oz Bio / Liveness

OZ_SERVICE_TFSS_HOST = 'http://bio-server-name:8501/v1/'

OzCapsula configuration parameters

OZ_SESSION_TOKEN_LIFETIME=<your_ttl_for_session_token>
OZ_JWT_PRIVATE_KEY_PATH=<jwt_private_key_path>
OZ_JWT_PUBLIC_KEY_PATH=<jwt_public_key_path>
OZ_MALEWICZ_ANALYSIS_ENABLED=true

Timing and limits

Please note: we stopped supporting Celery in 6.5.0.

# amount of retries to perform analyses to Oz Bio
OZ_CELERY_RETRY_MAX_COUNT = 7
# delay between tries
OZ_CELERY_RETRY_STEP = 30

# maximum wait time of one analyse
OZ_ANALYSE_PROCESSING_EXPIRE_TIMEOUT = 15 * 60  # 15 minutes
# maximum wait time of analyse from API
OZ_ANALYSE_DELIVERY_EXPIRE_TIMEOUT = 60 * 60  # 1 hour
# frequency for check analyse expiration
OZ_ANALYSE_EXPIRE_BEAT_PERIOD = 1 * 60  # every minute

# maximum amount of attached media
OZ_ATTACHMENT_MAX_COUNT = 10
# maximum size of one media file
OZ_ATTACHMENT_MAX_SIZE = 24 * 1024 * 1024  # 24 Mb

# amount of seconds until access token expiration
OZ_SESSION_TTL = 60 * 15  # 15 minutes
# amount of seconds until service access token expiration
OZ_SESSION_LONGLIVE_TTL = 60 * 60 * 24 * 365 * 5  # 5 years

# maximum size of thumbnail in bytes
OZ_IMAGE_SIZE_THUMBNAIL = 300
# maximum duration of video file
OZ_VIDEO_DURATION_MAX = 30

To prevent TFSS overload, you can now manage the number of concurrent requests API sends to TFSS. This is done via the OZ_SERVICE_TFSS_CONCURRENCY_LIMIT_MODE parameter. Please check the possible options below.

Value	Description	Additional parameters to set
OFF	Default; no limits applied	-
TOTAL	A shared limit for all analysis types	Set the limit in OZ_SERVICE_TFSS_CONCURRENCY_LIMIT (default: 0)
SEPARATE	A limit for each analysis type	Set the limit for each of the analyses: OZ_SERVICE_TFSS_CONCURRENCY_LIMIT_QUALITY, OZ_SERVICE_TFSS_CONCURRENCY_LIMIT_BIOMETRY, OZ_SERVICE_TFSS_CONCURRENCY_LIMIT_COLLECTION.

On exceeding the limit, the API returns HTTP 429 Too Many Requests.