API fundamentals

Every AgencyMax API follows the same conventions and is reached through the same API gateway. These pages describe behavior that applies to all of the APIs.

Topic	Summary
Environments and base URLs	Where the APIs live and how their URLs are built.
Developing against Test	Build and test against Test, where releases arrive first, then move to Production.
Subscription keys	Pass your subscription key on every request in Ocp-Apim-Subscription-Key.
Authentication	Get OAuth 2.0 bearer tokens with the tenant and API scopes you need.
Tenants	Every tenant-scoped URL starts with your tenant identifier, which must match your token.
Rate limits and quotas	Throttling (429), quotas and how to back off.
Errors	Status codes and RFC 9457 problem details.
Pagination and sorting	pageIndex, pageSize and sort.
Partial updates	How PATCH differs from PUT, and how to clear a value.
Data formats	JSON conventions, dates, jurisdictions and nulls.
Auditing	The initiator field, and why you should set it to the real user.
Versioning	How API versions and breaking changes are handled.
Best practices	Retries, idempotency, caching and security.