Skip to main content
The Postman collection covers every Developer API endpoint — status and auth, the OAuth flows, locations and connections, menu read/publish, the full order loop, and webhooks. It ships with helper scripts so you can run a flow end to end without copy-pasting ids between requests.

​
Download

Collection

All endpoints, example bodies, and scripts.

Staging environment

Points at api.staging.maple.inc; use your mpk_test_… key.

Production environment

Points at api.maple.inc; use your mpk_live_… key.

​
Get set up

1

Import the collection and an environment

In Postman, Import the collection file, then import the Staging (or Production) environment file. Select that environment in the top-right environment selector.
2

Add your API key

Open the environment and paste your key into apiKey — mpk_test_… for staging, mpk_live_… for production. That’s the only value you need to set for API-key auth.
Requests send Authorization: Bearer {{bearerToken}}. When bearerToken is empty it automatically falls back to your apiKey, so setting apiKey is enough.
3

Confirm the credential

Run Status & Auth → Current app (/me). A 200 with your app name, environment, and scopes means you’re ready.
4

Run a flow

Run Locations & Connections → List locations, then Get location / Create connection below it — the list request saves the first locationId into the environment, so the requests under it just work. The same chaining captures orderId, subscriptionId, and eventId.

​
What the scripts do

  • Auth fallback — a collection pre-request uses your apiKey as the bearer token unless an explicit bearerToken is set.
  • Id chaining — list requests save the first returned id (locationId, orderId, subscriptionId, eventId) to the environment for the requests that need it.
  • Webhook secret capture — Create webhook subscription stores the one-time signing_secret into signingSecret (store it securely; it’s shown only once).
  • OAuth (optional) — the OAuth folder exchanges client credentials for an access token and switches bearerToken to it automatically. It also includes a PKCE generator and the authorization-code exchange. Clear bearerToken to switch back to your API key.
Money fields are integer minor units (cents). The publish-menu request includes a complete example document you can adapt. For field-by-field detail, see the API reference and The menu model.