Environments and base URLs

Every AgencyMax API is reached through the AgencyMax API gateway. The gateway enforces subscription keys, rate limits and quotas.

Environments

Environment	Gateway	Purpose
Test	https://api-test.agencymax.example.com	Integration development and testing. Data may be reset.
Production	https://api.agencymax.example.com	Live agency data.

Subscription keys and OAuth clients are issued per environment. A test key or token won't work in production.

tip

Build and test your integration against Test. Releases reach Test before Production, and the API Portal sends its requests to Test. See Developing against Test.

URL structure

Tenant-scoped API URLs follow this pattern:

https://{gateway}/{api-path}/{tenantIdentifier}/{resource}

Segment	Description
gateway	The API gateway host for the environment.
api-path	The API's path, such as agency-management. The API Portal shows the exact value.
tenantIdentifier	Your agency's tenant identifier. See Tenants.
resource	The resource path, such as agents/A1001.

For example, this URL retrieves agent A1001 for tenant acme:

https://api.agencymax.example.com/agency-management/acme/agents/A1001

note

A few operations are not tenant-scoped. They are shared platform resources, such as Business Insights report recipes, and don't include a tenant segment.

Transport

• HTTPS (TLS 1.2 or later) is required.
• Request and response bodies are JSON (application/json). Error responses use application/problem+json.
• Send Content-Type: application/json with every request that has a body.