Skip to main content

Development Enviroment

💻 Configure your Development Environment​

To streamline your API integration process, we offer two powerful tools:

  1. Apollo Server Studio Sandbox: A user-friendly development environment that allows you to explore and test GraphQL queries, mutations, and subscriptions interactively. With Studio Sandbox, you can fine-tune your GraphQL requests, preview responses, and ensure seamless integration with our API.

  2. Postman: A widely used API testing tool that simplifies endpoint testing and automation. We've provided a comprehensive collection of API endpoints and an accompanying environment variable file to expedite your testing process. Postman enables you to authenticate requests, send various HTTP methods, and analyze responses effortlessly.

These tools are designed to enhance your experience when working with our API, making it easier than ever to validate, experiment, and integrate your applications effectively.

Apollo Server Studio Sandbox​

You can access the Apollo Server Studio Sandbox tool using the URL we have provided to test your integration by accessing it through your favourite web browser. It will be in a format similar to: https://sandbox-X-partner-api.pre.domain.com/graphql

Apollo Server Studio Sandbox

Apollo Server Studio Sandbox Headers​

If you chose to use Apollo Server Studio Sandbox tool to work with the sandbox, you need to know that you must set up the headers before each request.

The header that you should configure in each request is the Authorization. This header is needed to allow the user to use the api, the authorization should start with "Bearer X" where the X is the access token.

To get the accessToken for the Authorization you should request GetApplicationToken before any other request, the GetApplicationToken do not need to configure any header.

The Headers should be configured similar as the next image:

Apollo Server Studio Sandbox Header

Postman​

Download Postman Collection and Environment Variables

To streamline your API testing and integration, we provide a convenient way to access our API endpoints. You can download the Postman collection, which is a pre-configured set of API requests, along with an environment variable file.

Postman Collection: This file contains a collection of pre-defined API requests, organized by functionality. You can import it directly into your Postman workspace, allowing you to quickly access and test different API endpoints.

Postman Collection (DE)

Postman Collection (ES/FR/IT/PT)

Environment Variables: The accompanying environment variable file is tailored to work seamlessly with the Postman collection. It contains variables like API URLs, authentication tokens, and other configuration settings. By importing this file into Postman, you can easily manage and customize your API requests.

Postman Environment Vars (DE)

Postman Environment Vars (ES/FR/IT/PT)

By downloading and using these resources, you'll be able to expedite your API testing and integration process, ensuring a smooth and efficient experience while working with our APIs.