• INTEGRATIONS AND DEVELOPER API • SETUP GUIDE

How to Use the Postman Collection and Handle API Errors

By Rivio Support Team
2 min read

What you will achieve in this guide

Follow this step-by-step documentation to configure custom B2B registration forms, approval workflows, and customer tagging.

EXPECTED SETUP TIME 5-10 Minutes
COMPATIBILITY All Shopify Themes & Plans
TECHNICAL DIFFICULTY Zero Code Required

Use the downloadable Rivio Postman collection to test application reads and status updates while respecting API rate limits.

Before you begin

Use the intended service account and select the destination list, channel, spreadsheet tab, or endpoint. Decide whether you are testing a new-submission event or an approval event, and use a clearly identifiable test application.

Start from the app's collection

The downloadable Postman collection provides the supported request paths and variables. Import it, set base_url and api_key, then run a read request before attempting a decision change. In Postman's Bearer Token field, paste only the key; Postman adds the Bearer scheme.

A rejected request may reflect a missing/invalid key, insufficient permission, a wrong resource ID, or the rate limit. The API permits 60 requests per 60 seconds per key; a 429 response requires waiting for Retry-After rather than immediate repeated requests.

Diagnose and resolve the problem

  1. Open Developer API and select Download Postman collection.

  2. Import the downloaded JSON into Postman.

  3. Set the collection base_url and api_key variables using the app’s documented values.

  4. Paste the key alone into the Bearer Token value: do not add another Bearer prefix, quotes, or a newline.

  5. Run List submissions, obtain a submission ID, and use it in the detail or update requests.

  6. Inspect errors; on HTTP 429, wait for the Retry-After interval before retrying.

Example

Import the current collection, set base_url and api_key, and run List submissions. For a negative test, temporarily use an invalid key.

Expected result

The valid request returns the intended data and the invalid credential is rejected; a 429 requires honoring Retry-After.

Limits and important behavior

  • Each API key permits 60 requests per 60 seconds.
  • Do not add duplicate Authorization headers when the collection already supplies Bearer authentication.
  • If Postman reports invalid header content, copy the key again and remove spaces or newline characters.

Troubleshooting and verification

If data does not reach the destination, confirm the application exists and is not Spam, then check the connection, event, and selected destination. Email-marketing services need an applicant email. Background failures do not undo a received submission.

Screenshots to add

Screenshot placeholder: Capture the relevant app screen for “How to Use the Postman Collection and Handle API Errors” after completing the setup. Show the controls used to open Developer API and select Download Postman collection. Add a second screenshot showing the result of this check: Inspect errors; on HTTP 429, wait for the Retry-After interval before retrying. Use dummy applicant details and mask any secrets.

Related guides