Skip to content

Swagger API Documentation

Introduction to Swagger

Swagger is a powerful and interactive API documentation tool that allows developers to explore, test, and integrate APIs with ease. Using Swagger, you can view detailed information about all available endpoints, the required parameters, and the structure of request payloads.

Our Swagger interface provides a user-friendly way to interact with our APIs, whether you're working in our production environment or experimenting in our sandbox environment.

Features of Swagger

  • Interactive API Documentation: View all available API endpoints, including details about parameters and response structures.
  • Try Out Functionality: Test API calls directly from the Swagger interface without needing a separate tool.
  • Payload Customization: Easily edit payload data to test different scenarios.
  • Error Handling: Get real-time feedback on API responses to identify issues or validate integrations.

How to Use Swagger

1. Access the Swagger Interface

2. Navigate the API Documentation

Once you open the Swagger interface:

  1. Explore the listed APIs, categorized by functionality.
  2. Click on an endpoint to expand its details.
  3. View required headers, parameters, and payload structures.

3. Try Out APIs

The "Try Out" feature in Swagger allows you to interact with the API in real time. Here's how:

  1. Click "Try Out": Open the endpoint you want to test and click the "Try Out" button.
  2. Enter Your API Key: Add your API key in the required header field (X-API-KEY).
  3. Customize the Payload: Edit the example payload to match the data you want to test.
  4. Execute the Command: Click "Execute" to send the request and view the response directly in the interface.

API Key Requirements

To use the "Try Out" feature, you'll need your API key. This key authenticates your request and determines your access to the system:

  • Add your API key in the X-API-KEY header field when prompted.
  • Ensure you use the appropriate key for either the sandbox or production environment.

Benefits of Using Swagger

  • Efficient Testing: Test API calls directly from your browser without setting up additional tools.
  • Improved Integration: Quickly understand how to interact with our APIs and customize your integration.
  • Streamlined Debugging: View responses instantly to troubleshoot and refine your API requests.

Swagger URLs

Explore our Swagger interface to fully harness the power of our APIs for your development needs!