Skip to main content

Getting started

This page walks you through your first BIDEX product feed download. The example uses Postman, but any HTTP tool or integration platform works the same way.

Prerequisites​

Before you start, make sure you have:

  • your API key (see Authentication)
  • your BuyersID — a UUID such as 123e4567-e89b-12d3-a456-426614174000
  • an HTTP tool such as Postman, curl or your integration platform

Step 1: create the request​

  1. Open Postman and create a new HTTP request.
  2. Select GET as the method.
  3. Enter the endpoint address:
https://connections.cyclingfactory.be/api/v1/bidex/products

Step 2: add authentication​

  1. Open the Headers tab. Add a header named x-api-key and enter your API key as the value.

Do not put the API key in the request address. See Authentication for why.

Step 3: add the query parameters​

  1. Open the Params tab and add BuyersID with your BuyersID as the value.
  2. Add format with the value csv if you want to open the result in Excel, or leave it out for JSON.

The request address now looks like this (the API key is deliberately not included):

https://connections.cyclingfactory.be/api/v1/bidex/products?BuyersID=YOUR-BUYERS-ID&format=csv

Replace YOUR-BUYERS-ID with the BuyersID supplied to you. Do not type the angle brackets sometimes used for placeholders.

Step 4: send and save​

  1. Select Send.
  2. When the response is successful (HTTP 200), save the response as bidex-products.csv (or .json).

Download all pages (JSON only)​

JSON responses are paginated: by default you receive 100 products per page. A CSV download always contains the complete catalog and ignores pagination.

To download the complete catalog as JSON:

  1. Start with page=1&size=1000.
  2. Save the returned page.
  3. Repeat the request with page=2, then page=3, and so on.
  4. Stop when a page contains no product records.
  5. Keep the same BuyersID, format, language, country and currency for every page.
https://connections.cyclingfactory.be/api/v1/bidex/products?BuyersID=YOUR-BUYERS-ID&format=json&page=1&size=1000

Quick checklist​

Before contacting support, confirm that:

  • the method is GET;
  • the endpoint ends in /api/v1/bidex/products;
  • x-api-key is in the headers, not in the address;
  • BuyersID is present, is a valid UUID and contains no extra spaces;
  • format is either csv or json;
  • language and country contain two letters;
  • currency contains three letters;
  • the page is a positive number and the size is at most 1000.

If something still fails, see Errors for the meaning of each status code.