Skip to main content

​
Overview

The Configuration class manages all SDK settings including API host, authentication credentials, debugging, and HTTP client options.

​
Creating a Configuration

use D4T\MT5Sdk\Configuration;

// Create a new configuration instance
$config = new Configuration();

// Or get the default configuration
$config = Configuration::getDefaultConfiguration();

​
Basic Configuration

​
Setting the API Host

Configure the base URL for your MT5 API server: 
// Set the host (default is '/v1')
$config->setHost('https://your-mt5-server.com/v1');

// Get the current host
$host = $config->getHost();
​
host
string
default:"/v1"
The base URL for the MT5 API server

​
Access Token (Bearer Authentication)

Configure the bearer token for authenticated requests: 
// Set access token for OAuth/Bearer authentication
$config->setAccessToken('your-bearer-token-here');

// Get current access token
$token = $config->getAccessToken();
The access token is obtained by calling the /init/ endpoint. See the Authentication guide for details.

​
Advanced Configuration

​
API Keys

For API key-based authentication (alternative to bearer tokens): 
// Set API key
$config->setApiKey('api_key_identifier', 'your-api-key');

// Set API key prefix (e.g., 'Bearer')
$config->setApiKeyPrefix('api_key_identifier', 'Bearer');

// Get API key with prefix
$keyWithPrefix = $config->getApiKeyWithPrefix('api_key_identifier');
// Returns: "Bearer your-api-key"

​
HTTP Basic Authentication

Configure username and password for HTTP basic auth: 
// Set credentials
$config->setUsername('your-username');
$config->setPassword('your-password');

// Get credentials
$username = $config->getUsername();
$password = $config->getPassword();
HTTP Basic Authentication is less secure than bearer tokens. Use bearer token authentication when possible.

​
User Agent

Customize the HTTP User-Agent header: 
// Set custom user agent (default is 'Swagger-Codegen/1.0.0/php')
$config->setUserAgent('MyApp/1.0.0');

// Get current user agent
$userAgent = $config->getUserAgent();

​
Debugging

​
Enable Debug Mode

Enable debugging to log HTTP requests and responses: 
// Enable debug mode
$config->setDebug(true);

// Set debug output file (default is 'php://output')
$config->setDebugFile('/var/log/mt5-api-debug.log');

// Check if debug is enabled
if ($config->getDebug()) {
    echo "Debug mode is enabled";
}
​
debug
bool
default:"false"
Enable or disable debug logging
​
debugFile
string
default:"php://output"
Path to debug log file. Use php://output for console output.

​
Debug Report

Generate a debug report with system information: 
$report = Configuration::toDebugReport();
echo $report;

// Output:
// PHP SDK (D4T\MT5Sdk) Debug Report:
//     OS: Linux hostname 5.4.0-42-generic #46-Ubuntu SMP
//     PHP Version: 8.1.0
//     OpenAPI Spec Version: 0.0.3-oas3
//     Temp Folder Path: /tmp

​
Temporary Files

​
Temp Folder Configuration

Set the directory for temporary files: 
// Set temp folder (default is sys_get_temp_dir())
$config->setTempFolderPath('/custom/temp/path');

// Get temp folder path
$tempPath = $config->getTempFolderPath();

​
Default Configuration

The SDK supports a singleton default configuration: 
// Get default configuration instance
$config = Configuration::getDefaultConfiguration();

// Modify default configuration
$config->setHost('https://api.example.com/v1');
$config->setAccessToken('your-token');

// Set a custom default configuration
$customConfig = new Configuration();
$customConfig->setHost('https://custom.example.com/v1');
Configuration::setDefaultConfiguration($customConfig);
Changes to the default configuration affect all API instances that use it. Consider creating separate Configuration instances for different environments.

​
Complete Configuration Example

use D4T\MT5Sdk\Configuration;
use D4T\MT5Sdk\MT5Manager\BasicApi;

// Create and configure
$config = new Configuration();
$config->setHost('https://mt5-server.example.com/v1');
$config->setAccessToken('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...');
$config->setUserAgent('MyTradingApp/2.0.0');
$config->setDebug(true);
$config->setDebugFile('/var/log/mt5-debug.log');

// Use configuration with API
$api = new BasicApi(null, $config);

// Verify configuration
echo "Host: " . $config->getHost() . "\n";
echo "User Agent: " . $config->getUserAgent() . "\n";
echo "Debug Enabled: " . ($config->getDebug() ? 'Yes' : 'No') . "\n";

​
Environment-Specific Configuration

Example of managing multiple environments: 
function getConfiguration($environment = 'production') {
    $config = new Configuration();
    
    switch ($environment) {
        case 'development':
            $config->setHost('https://dev-mt5.example.com/v1');
            $config->setDebug(true);
            $config->setDebugFile('php://output');
            break;
            
        case 'staging':
            $config->setHost('https://staging-mt5.example.com/v1');
            $config->setDebug(true);
            $config->setDebugFile('/var/log/mt5-staging.log');
            break;
            
        case 'production':
            $config->setHost('https://mt5.example.com/v1');
            $config->setDebug(false);
            break;
    }
    
    return $config;
}

// Usage
$config = getConfiguration('development');
$api = new BasicApi(null, $config);

​
Configuration Reference

PropertyTypeDefaultDescription
hoststring/v1API base URL
accessTokenstring''Bearer token for authentication
apiKeysarray[]API key authentication tokens
apiKeyPrefixesarray[]Prefixes for API keys (e.g., ‘Bearer’)
usernamestring''HTTP basic auth username
passwordstring''HTTP basic auth password
userAgentstringSwagger-Codegen/1.0.0/phpHTTP User-Agent header
debugboolfalseEnable debug logging
debugFilestringphp://outputDebug log file path
tempFolderPathstringsys_get_temp_dir()Temporary files directory

​
Next Steps