Make Your First Platform Function API Call

Punchh provides a robust platform for offering loyalty programs to customers. When a business integrates its back-end with the Punchh server, the Punchh APIs become instrumental in executing loyalty programs for enrolled customers, primarily via business-branded mobile apps and websites tailored by Punchh.

To establish integration with the Punchh APIs, you need to understand how they are invoked and what responses are returned by the Punchh server. You can call APIs using any suitable API test client (e.g., Postman). Thus, the response to every API call made in Postman under a chosen environment (in app and/or platform) is reflected in the app and/or platform.

Base URIs

Please reach out to your Punchh representative in order to receive the sandbox and production base URLs that you should be using in order to consume the Punchh APIs.

Making Your First API Call

An API key needs to be passed in the Authorization header as a bearer token.

Authorization: Bearer <BUSINESS_ADMIN_KEY_GOES_HERE>

If you do not have the API key, reach out to your Punchh representative.

If you have already obtained the admin key and you know which environment that key belongs to (production or sandbox), you can make your first API request.

Required Parameters

Required parameters must be passed in POST and GET API calls as shown in the example below.

curl -X GET \
  https://SERVER_NAME_GOES_HERE.punchh.com/api2/dashboard/locations \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer BUSINESS_ADMIN_KEY_GOES_HERE' \
  -H 'cache-control: no-cache'