Developers

API quickstart

Create your first pass over the REST API in a few minutes - get a key, call the endpoint, and get back an install link you can send to a customer.

API keys and authentication

Creating and revoking API keys, how bearer authentication works, why a key is only shown once, and how to handle rotation without downtime.

Creating passes over the API

The patterns that matter when you issue passes from your own systems - field ids, tags, listing and paginating, updating, pushing a message, and voiding.

External IDs and idempotency

Why setting extId on every pass is the single most important decision in an API integration - it prevents duplicates on retry and lets you address passes by your own reference.

Webhooks

Get told when a pass is created, updated, installed or removed - setting up an endpoint, verifying the signature, handling retries, and what each event means.

API errors and rate limits

The error envelope, what each code means and whether retrying will help, plus the request rate limit and how to stay inside it.