Quickstart

This guide uses a test key, so passes are signed with TapAce’s demo certificate and you don’t need Apple or Google credentials yet.

Create a test API key

In the dashboard, open Developers → API keys, choose Test and select Create key. Copy the key straight away: it starts with tapace_test_ and is shown only once.

Design a template

Open Templates → New and design your pass. For every value that changes from holder to holder, such as a member name, set the field’s Value binding to Per-pass value. Its key is the name you send in fieldValues.Copy the template ID from its page, then check which fields each pass needs:

curl https://api.tapace.lk/v1/templates/tmpl_Q4vN8xT2mLr7KpZs3Wd1 \
  -H "Authorization: Bearer $TAPACE_API_KEY"

The response lists them in requiredFields, for example ["memberName"].

Issue a pass

curl https://api.tapace.lk/v1/passes \
  -H "Authorization: Bearer $TAPACE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "templateId": "tmpl_Q4vN8xT2mLr7KpZs3Wd1",
    "holderName": "Nimal Perera",
    "holderEmail": "nimal@example.com",
    "fieldValues": { "memberName": "Nimal Perera", "points": 120 }
  }'

The response is the new pass. Keep its id so you can update it later.

Send it to the holder

The pass carries a distributionUrl, such as https://pass.tapace.lk/6BkJLsso1xyB. Open it on a phone, or send it to the holder by email or SMS. The page offers Add to Apple Wallet or Save to Google Wallet. See Deliver passes.

Update it

Change a value and TapAce pushes the update to every wallet that saved the pass:

curl -X PATCH https://api.tapace.lk/v1/passes/pass_7hGk2LmQ9xVt4RnB8cYe \
  -H "Authorization: Bearer $TAPACE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{ "fieldValues": { "points": 150 }, "notificationMode": "notify" }'

Getting started

Basics

Guides

API keys

Passes

Templates

Assets

Next steps

Go live

Webhooks

​Next steps

Go live

Webhooks

Next steps