Base URL¶

All requests made to Amperity API endpoints should be directed to the base URL.

Amazon AWS¶

Tenants hosted in Amazon AWS have the following base URL:

https://app.amperity.com/api

Use the amperity-tenant header to provide the tenant ID.

You can find the tenant ID from the Amperity user interface. From the Settings page and select the Security tab. Under API keys, in the row for an API key, open the menu and select Copy tenant ID.

Microsoft Azure¶

Tenants hosted in Amazon AWS have the following base URL:

https://{tenant-id}.amperity.com/api

Note

The tenant ID must be in the base URL and in the amperity-tenant header.

For example, if the tenant ID is socktown the base URL is:

https://socktown.amperity.com/api

with

--header 'amperity-tenant: socktown'

Base URL and sandboxes¶

The base URL for a sandbox is the same as the base URL for production.

Use the tenant ID for the sandbox for all requests made to a sandbox. unique to the sandbox. For example, if the tenant ID for a sandbox is socktown-sb-12345 the base URL is the same as the base URL for production and the amperity-tenant header is:

--header 'amperity-tenant: socktown-sb-12345'