Skip to main content

Postman

Instructions for using the Postman application with our endpoints.

JSON Collection​

The JSON collection contains pre-configured requests for all available API endpoints. It makes interacting with our service much easier.

To download the Postman collection, click the link below:

Download the JSON collection

How to import the collection into Postman​

  1. Open the Postman application
  2. Click the "Import" button in the top-left corner of the application
  3. Drag and drop the downloaded file, or select the file to import

After importing, you'll see the collection in Postman's left sidebar menu. You can now expand the collection to see the available API endpoints.

Getting started with the collection​

To use the Postman collection effectively, it's essential to set up your environment correctly. This includes setting environment variables such as api_key and url to match your specific context of use. Follow these steps to set it up:

  1. Download or create an environment: Start by downloading the preconfigured environment, or by creating a new one within Postman. This environment should include the essential fields api_key and url.

  2. Set up the environment:

    • If you downloaded an existing environment, import it into Postman the same way you imported the collection.
    • To create a new environment, click the New button in the top-left corner of Postman, then select "Environment" to define a new environment. Here you'll need to add the required variables:
      • api_key: Your personal API key, which authenticates your requests.
      • url: The base URL for the API endpoints. This typically differs between development and production environments.

  3. Enter the environment variables:

    • For api_key, enter the key you obtained from your profile, under the API section.
    • For url, enter the default URL available for accessing the API.

  4. Select the environment: Once your environment is set up and selected in Postman, every request made using the collection will automatically use the variables you've configured, ensuring your API calls are properly authenticated and routed.

By following these steps, you'll have a working Postman environment set up to interact with the API using the provided collection. This setup not only simplifies development workflows, but also ensures your requests are securely authenticated and correctly routed to the intended API endpoints.

For more detailed information on using Postman, please refer to the official Postman documentation.

We hope this guide helps you test and integrate with our API efficiently. If you have any questions or need further assistance, please reach out to our support team.