#API playground
Ponch hosts an interactive API explorer where you can send real requests from
your browser:
https://app.getponch.com/api/docs
#Using it
- Open the page and click Authorize (top right).
- Paste your API key into the MerchantAPIKeyAuth box
and click Authorize, then Close. Leave MerchantJWTAuth empty:
that one is for the Ponch dashboard.
- Open an endpoint, click Try it out, fill in the parameters or body, and
click Execute. You'll see the response, plus the equivalent
curl
command to copy.
The raw OpenAPI schema is at https://app.getponch.com/api/openapi.json, if
you want to generate a client.
#Things to know
- It acts on your real data. There's no sandbox. Stamping or redeeming here
changes a real card and updates the customer's wallet pass straight away. To
experiment, create a test stamp card in the dashboard, add a card to your own
phone, and use that barcode.
- It lists every endpoint, including dashboard-only ones. Only the
endpoints in the endpoint reference accept an API key. The
rest return
401 even with a valid key, which doesn't mean your key is
broken.
- Text in responses follows the language you last chose in the Ponch
dashboard, or else your browser's language. Your own integration should send
Accept-Language explicitly. See Language.