Quickstart
This guide will get you all set up and ready to use the Crater API. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.
Before you can make requests to the Crater API, you will need to grab your API keys from us.
Generate Management Token
After getting the api keys, you are ready to make your first call to the Crater API. Follow the Auth Guide to generate a management token to use in your API calls.
Making your first API request
Below, you can see how to send a GET request to the Businesses endpoint to get a list of all your businesses. In the cURL example, results are limited to ten businesses, the default page length for each request.
curl https://payments.your-domain.com/api/v2/businesses \
-H "Authorization: Bearer {token}"
What's next?
Great, you have made your first request to the API. Here are a few links that might be handy as you venture further into the Crater API: