5. API reference
The full, always current reference is generated from the API itself (OpenAPI 3):
- Interactive reference: api.walletcraft.app/api/docs
- OpenAPI document:
https://api.walletcraft.app/api/docs/json— import it into Postman, Insomnia or a code generator.
The endpoints a website uses:
| Method & path | Key access | What it does |
|---|---|---|
POST /api/v1/templates/{templateId}/passes |
Website / Full | Issue a card (finds or creates the customer) |
GET /api/v1/passes/{id} |
Website / Full | The card, its balance and level |
GET /api/v1/passes/{id}/operations |
Website / Full | Purchases and points history |
GET /api/v1/passes/{id}/consent |
Website / Full | News & offers consent |
PUT /api/v1/passes/{id}/consent |
Website / Full | Give or withdraw it |