English
Servers
Regional Requests
When sending API requests, you must use the appropriate region and environment where your client's data is stored. Depending on your needs, particularly regarding proximity and regulatory requirements, we can create your environment in one of the supported regions.
The general URL format to use when sending requests is as follows: https://{sInfrastructureenvironmenttypeDescription}.api.appcluster01.{sInfrastructureregionCode}.ezmax.com/rest/
The values "{sInfrastructureenvironmenttypeDescription}" and "{sInfrastructureregionCode}" must be replaced with one of the values listed in the tables below.
Global Requests
Some functions must be called through the Global infrastructure rather than the regional servers. These functions are all grouped under the Global section of the documentation.
The general URL format to use when sending requests is as follows: https://{sInfrastructureenvironmenttypeDescription}.api.global.ezmax.com/
The value "{sInfrastructureenvironmenttypeDescription}" must be replaced with one of the values listed in the tables below.
WebSocket Requests
When sending WebSocket requests, you must use the appropriate region and environment where your client's data is stored.
The general URL format to use when sending requests is as follows: wss://ws.{sInfrastructureregionCode}.ezmax.com/{sInfrastructureenvironmenttypeDescription}/
The values "{sInfrastructureregionCode}" and "{sInfrastructureenvironmenttypeDescription}" must be replaced with one of the values listed in the tables below.
Environments
| sInfrastructureenvironmenttypeDescription | Description |
|---|---|
| iso | Isolated Customers |
| prod | Production |
| stg | Staging |
| qa | Quality Assurance |
| dev | Development |
INFO
You must always use the prod environment unless otherwise instructed by the eZmax support team.
Regions
| sInfrastructureregionCode | Description |
|---|---|
| af-south-1 | Africa (Cape Town) |
| ap-east-1 | Asia Pacific (Hong Kong) |
| ap-northeast-1 | Asia Pacific (Tokyo) |
| ap-northeast-2 | Asia Pacific (Seoul) |
| ap-northeast-3 | Asia Pacific (Osaka) |
| ap-south-1 | Asia Pacific (Mumbai) |
| ap-south-2 | Asia Pacific (Hyderabad) |
| ap-southeast-1 | Asia Pacific (Singapore) |
| ap-southeast-2 | Asia Pacific (Sydney) |
| ap-southeast-3 | Asia Pacific (Jakarta) |
| ap-southeast-4 | Asia Pacific (Melbourne) |
| ca-central-1 | Canada (Central) |
| ca-west-1 | Canada West (Calgary) |
| eu-central-1 | Europe (Frankfurt) |
| eu-central-2 | Europe (Zurich) |
| eu-north-1 | Europe (Stockholm) |
| eu-south-1 | Europe (Milan) |
| eu-south-2 | Europe (Spain) |
| eu-west-1 | Europe (Ireland) |
| eu-west-2 | Europe (London) |
| eu-west-3 | Europe (Paris) |
| il-central-1 | Israel (Tel Aviv) |
| me-central-1 | Middle East (UAE) |
| me-south-1 | Middle East (Bahrain) |
| sa-east-1 | South America (São Paulo) |
| us-east-1 | US East (N. Virginia) |
| us-east-2 | US East (Ohio) |
| us-west-1 | US West (N. California) |
| us-west-2 | US West (Oregon) |
INFO
Our SDKs use ca-central-1 as the default region. You may need to change this default value if your services are hosted in a different region.