Getting API Access

As a marketplace app, you don't generate your own API key — ROLLER delivers
one to your app when an operator connects it to their venue. Manual key
generation in Venue Manager exists only for testing before your app is live on
the marketplace (see Testing before your app is live below).

How marketplace apps receive their key

Once your app has been submitted and approved on the marketplace:

1. A venue operator triggers the connection to your app from the marketplace.
2. ROLLER generates a scoped API key for that venue and sends it to your app
   in the venue.connect webhook.
3. Your app stores that key and uses it for all future requests to the ROLLER
   Platform API for that venue.

You never mint or rotate these keys yourself — ROLLER manages their lifecycle and
scopes. See the Integration Apps guide for the full
connect/disconnect webhook contract, and Authentication for
using the delivered key.

Testing before your app is live

Before your app is available on the marketplace — or before its connect webhook
is wired up — you can generate a key manually in a test venue to explore the
API. This path is for experimentation only; production marketplace connections
always use the delivered key described above.

1. Login to Venue Manager
2. Navigate to Settings > Integrations > API keys
3. Click the Create client key button.
4. Enter a description into Client key name. Use a name that describes the consumer app or purpose, such as Marketplace App Testing.
5. Click Create.

📘

Getting started?

We recommend using ROLLER Playground to test and set up your integrations before using the Live environment. The steps for generating credentials above are the same in Playground.

Read more on the environments page.

Need a test venue or API access enabled? Reach out to your Client Success
Manager or contact ROLLER Support. If you're not yet a ROLLER partner, get in touch via our Contact Page.