Documentation

BaseApi.php

Settings and variables linked to all API usage.

API_KEY_ENV_NAME = 'MINDEE_API_KEY': Default key name for the API key entry in environment variables.
BASE_URL_DEFAULT = 'https://api.mindee.net/v1': Default URL prefix for API calls.
BASE_URL_ENV_NAME = 'MINDEE_BASE_URL': Default key name for the Base URL in environment variables.
REQUEST_TIMEOUT_ENV_NAME = 'MINDEE_REQUEST_TIMEOUT': Default key name for CURL request timeout in environment variables.
TIMEOUT_DEFAULT = 120: Default timeout value for curl requests.

Default key name for the API key entry in environment variables.


    public
        mixed
    API_KEY_ENV_NAME
    = 'MINDEE_API_KEY'

Default URL prefix for API calls.


    public
        mixed
    BASE_URL_DEFAULT
    = 'https://api.mindee.net/v1'

Default key name for the Base URL in environment variables.


    public
        mixed
    BASE_URL_ENV_NAME
    = 'MINDEE_BASE_URL'

Default key name for CURL request timeout in environment variables.


    public
        mixed
    REQUEST_TIMEOUT_ENV_NAME
    = 'MINDEE_REQUEST_TIMEOUT'

Default timeout value for curl requests.


    public
        mixed
    TIMEOUT_DEFAULT
    = 120

Get the User Agent to send for API calls.


    
                    getUserAgent() : string

string