API resources, scopes and retries

Step by step

1. 1

   Cards: GET /vcards and /vcards/{id} require vcard:read; POST /vcards, PUT /vcards/{id} and POST /vcards/{id}/clone require vcard:write.

2. 2

   QR codes: GET /qr-codes and /qr-codes/{id} require qr:read; existing POST /qr-codes and PUT /qr-codes/{id} require qr:write. Secure shares: GET /secure-shares and /secure-shares/{id} require share:read; POST /secure-shares requires share:write.

3. 3

   Payments: GET /payment-links, /payments and their /{id} routes require payments:read; POST /payment-links requires payments:write. Use integer minor units for amounts, for example 50000 for AED 500.

4. 4

   Events: GET /events and /events/{id} require events:read; POST /events requires events:write; GET /events/{id}/registrations requires events:registrations:read.

5. 5

   Surveys: GET /surveys and /surveys/{id} require surveys:read; POST /surveys requires surveys:write; GET /surveys/{id}/responses requires surveys:responses:read. GET /analytics requires analytics:read.

6. 6

   Resource lists accept limit 1–100, offset and optional ISO since. Registrations/responses accept limit and offset. Follow items and next_offset until complete.

7. 7

   Handle validation errors before retrying, check access/plan for authorization errors, resolve idempotency conflicts, and back off when rate limited. New API capabilities allow 120 successful requests per minute per client.