All Piano APIs have a base URL to which the endpoint paths are appended. All API endpoints are relative to the base URL.
For example, assuming the base URL is https://api.piano.io/api/v3, the /publisher/user/get endpoint refers to https://api.piano.io/api/v3/publisher/user/get.
The Piano API Reference documentation for each API call shows the method, path, and parameters that must be appended to the base URL to form a request.
The following is an example of a well-formed request URL:
https://api.piano.io/api/v3/publisher/user/get?aid=<AID>&uid=<UID>&api_token=<API_token>
which is composed of the following parts:
Base URL: https://api.piano.io/api/v3
Path:
/publisher/user/getQuery parameter:
aid=<AID>&uid=<UID>API token
All calls that you make to the publisher API must be made using your API token that can be found on the homepage of the Piano dashboard. If you have trouble locating your API token, contact Piano customer support at support@piano.io. Your API token should be protected and hidden from public view.
Piano Management + Billing Base URLs
The base URLs for the Piano Production environment API (based on the region of your Piano dashboard) are:
https://api-au.piano.io/api/v3 (Australia)
https://api-ap.piano.io/api/v3 (Asia-Pacific)
https://api-eu.piano.io/api/v3 (Europe)
Sandbox Environment Subscription Management + Billing Base URL
The base URL for the Piano Sandbox environment API is:
https://sandbox.piano.io/api/v3
Reports Base URL
The base URL for creating and downloading Piano reports is:
https://reports-api.piano.io/rest
Identity Management Base URL
The base URL for Identity Management API endpoints is:
https://api.piano.io/id/api/v1
https://api-ap.piano.io/id/api/v1 (Asia-Pacific)
https://api-au.piano.io/id/api/v1 (Australia)
https://api-eu.piano.io/id/api/v1 (Europe)
https://sandbox.piano.io/id/api/v1/ (Sandbox)
Piano ESP Base URLs
ESP offers two different environments to the public: Sandbox and Production. The base URLs for the ESP Production environment API are:
https://api-esp.piano.io (America)
https://api-esp-eu.piano.io (Europe)
https://api-esp-ap.piano.io (Asia-Pacific)
The base URL for the ESP Sandbox environment API is:
https://sandbox-api-esp.piano.io
Piano API Endpoints and Limitations
More information about the Piano API as well as the individual public endpoints is available here.
A reference to ESP API endpoints can be found here.
Please note, that for certain API endpoints rate limitations apply. These are listed under the following link.