Postman Collections

To make your integration with the Affilibee API as smooth as possible, we provide pre-configured Postman collections for both our Sandbox and Live environments.

These collections include all available API V2 endpoints, pre-set with the necessary authentication headers and environment variables.

Download Collections

You can download the latest version of the Postman collections directly from the links below:

• Download Sandbox Collection
• Download Live Collection

Import via URL

You can import our collections into Postman using their public URLs. Simply copy the link below and paste it into Postman's Import > Link section:

Sandbox Collection URL

https://affilibee.com/docs/collections/affilibee-sandbox-postman-collection.json

Live Collection URL

https://affilibee.com/docs/collections/affilibee-live-postman-collection.json

Getting Started

1. Import to Postman: Open Postman and click the Import button. Drag and drop the downloaded .json files into the import area.
2. Set Environment Variables: Each collection comes with built-in variables to simplify your requests. Set these once in the collection's Variables tab (or in your Postman environment):
   • base_url: This is set to {{base_url}} by default. Ensure your environment variable for base_url is set to the correct API root (e.g., https://affilibee.com).
   • api_token: Your personal API access token - a testing token for the Sandbox collection, a live token for the Live collection. See the Authentication guide for how to generate this.
   • currency_code: Your merchant account currency (USD by default). Orders must use it.
   • sender_email: The email of one of your team members, used when inviting affiliates.
   • affiliate_slug: The affiliate new orders are credited to. Running List affiliates fills it in with your first affiliate when it is empty.
3. Authentication: The collections are pre-configured to use Bearer Token authentication using the {{api_token}} variable. This token is automatically added to the Authorization header of every request.

Ready-to-send Requests

Every request comes pre-filled, so you can send it straight away:

• Bodies contain working example values. Create order uses a new order number on every send (ORDER-{{$timestamp}}) and a random customer, so you can send it repeatedly.
• Query parameters such as per_page, page and filters are listed on every list request, switched off. Tick the ones you want to use.
• Ids in paths (:uuid, :slug) are filled in from collection variables such as {{order_uuid}}. The create and list requests fill these in for you: after Create order, Get order, Update order and Cancel order work on the new order immediately.

Sandbox vs. Live

Sandbox Environment

• Purpose: Testing and development.
• Base Path: /api/v2/sandbox/
• Data: Isolated from live production data. Use this to safely test your integration without affecting your real account.

Live Environment

• Purpose: Production use.
• Base Path: /api/v2/
• Data: Real-world data. Requests made here will have immediate effects on your account and transactions.

Tips for Testing

• Accept Header: All requests in the collection are pre-configured with Accept: application/json.
• Content-Type: All requests that send a body are pre-configured with Content-Type: application/json.
• Trace ID: Every response from the V2 API includes a trace_id in the meta object. This is also visible in Postman and should be provided when contacting support.