--- title: "API overview" slug: "api-overview" updated: 2026-07-04T22:21:14Z published: 2026-07-04T22:21:14Z canonical: "mysupport.roller.software/api-overview" --- > ## Documentation Index > Fetch the complete documentation index at: https://mysupport.roller.software/llms.txt > Use this file to discover all available pages before exploring further. # API overview This guide provides an overview of ROLLER's different APIs and best practices. See the [API changelog](https://docs.roller.app/docs/api/changelog) to keep up-to-date with updates to the ROLLER API. > [!CAUTION] > API access > > API access is an add-on feature to an existing ROLLER subscription. Contact your customer success manager or the [support team](/v1/docs/contact-roller-support) if you're interested in subscribing to this feature. > > [Learn more](https://www.roller.software/features/api-integrations/) ## APIs API documentation can be found in the ROLLER developer center at [https://docs.roller.app](https://docs.roller.app). ROLLER has two APIs as follows: - **Reporting API** The Reporting API provides venues with a mechanism to extract ROLLER data and syndicate that data to an external database, business intelligence or analytics platform. It does not provide any ability to write data to ROLLER. This API should not be used for real-time data use cases, as it does not allow you to query specific records, and returns paginated data for a time period. It is optimized for periodic export of records on an hourly or daily frequency. For more information, see the guide [Reporting API overview](/v1/docs/data-api) and [Reporting API](https://docs.roller.app/docs/api/reporting) in the ROLLER developer center. - **Rest API** The Rest API is a general-purpose API which supports live use cases and enables the creation of ROLLER bookings. For more information, see [Rest API](https://docs.roller.app/docs/api/rest) in the ROLLER developer center. ## General concepts ### Authentication ROLLER APIs use an OAuth2 flow whereby the consuming app uses its client id and client secret from ROLLER to request an access token from the /token endpoint. It is this access token that is used in calls to API endpoints. The access token is short-lived. Its expiry is provided in the token response and may change from time to time. Therefore consumer apps should always reuse the current token until they receive a ***401 (Unauthorised)*** response from any endpoint at which time they should request a new token. **Do not request a new token for each API call.** This may result in a ***429 (Too many requests)*** response and result in the suspension of your API credentials/access. For more information regarding the authentication endpoint, go to [API authentication](https://docs.roller.app/docs/api/authentication) in the ROLLER developer center ### Scope The scope of a set of API credentials (client id and client secret) is limited to a single venue. If you have multiple ROLLER venues you must create separate sets of credentials for each venue. For more information regarding creating API credentials, go to [API access](https://docs.roller.app/docs/api/getting-api-access) in the ROLLER developer center. A set of credentials will enable the consumer app to access both the production and playground environment endpoints as per information regarding environments. ### Rate limiting Each set of API credentials are limited to one API call per second. Therefore we do not recommend sharing a set of API credentials between multiple consumer apps as for multiple consumers/apps as this may result in a ***429 (Too many requests)*** response. ## Create API credentials in ROLLER After subscribing to API access with ROLLER, you can create API credentials to link ROLLER's public API with an external application by following these steps: 1. From Venue Manager, go to **Settings** > **Integrations** > **API Keys** 2. Select **Create client key** on the top left of the screen 3. A pop-up window will be displayed. - Select to create **API Key** or **Gate Server Key** from the toggle options - Enter a description to the **Client key name** field which describes the consumer app that these credentials will be allocated to, for example, "Data warehouse app" 4. Select the **Create** button. Enter the client ID and client secret ID into the appropriate fields in the external application's account. If you're not sure where, contact the provider's support team. To learn more, see [Generate a ROLLER API key](https://docs.roller.app/docs/api/getting-api-access) in the ROLLER developer center. See the guide [Extend your capabilities with our integrations](/v1/docs/extend-your-capabilities-with-our-integrations) to find out more about the integrations we currently support and our [partner directory](https://www.roller.software/partners). ## Creating API keys for multiple venues(HQ) If you're working from HQ and want to generate a key that works across **multiple connected venues**: 1. Select "API Key" as the key type. 2. Enter a Client key name to describe the integration or app. 3. Check the box for “Create keys for multiple venues.” 4. Use the **Select** **venues** drop-down to choose one or more venues connected to HQ that you would like to include. 5. Select **Create** to generate the keys. ![](https://cdn.us.document360.io/23700755-951c-4b69-8afe-ec8b33c6c689/Images/Documentation/13057642949903.png) ## Related - [Configure online accounts in progressive checkouts](/configure-online-accounts-in-progressive-checkouts.md) - [ROLLER + Amusement Connect cashless card integration](/roller-amusement-connect-cashless-card-integration.md) - [Extend your capabilities with our integrations](/extend-your-capabilities-with-our-integrations.md) - [Reporting API overview](/data-api.md) - [Add the overlay checkout experience to your website](/add-the-overlay-checkout-experience-to-your-website.md)