docs
Hubex
API Docs

Hubex API Documentation

Hubex is built on an API-first strategy to ensure effortless development through proven, pre-built integrations. Connect to Hubex and open your business to multiple pre-integrated APIs to empower your ecosystem. All integrations are available for “plug-and-play” on a single platform. Simply use the credentials from the API providers and configure with Hubex to standardize integrations and automate upgrades. Hubex API Library gives you easy access to a wide range of pre-configured APIs on a singular, unified platform.

Hubex reduces costs significantly by providing multiple integrated APIs on a single hub, resulting in a significant reduction in person-hours required. Hubex guarantees a seamless developer experience by constantly updating with any new advancements by the specified APIs.

For Complete Hubex API Documentation Click Here (opens in a new tab).

How to Connect ?

Hubex is a pure-play SaaS product with a secure RESTful API. The API can be consumed by invoking the methods available in the subscription using this OpenAPI documentation.

Pre-requisites

Before you can use Hubex, you must complete the following step:

  1. Register on Appex-Now Website (opens in a new tab).
  2. Purchase Hubex subscription or start for free using the available Trial subscription.

After completing the Prerequisites you can follow the following steps to connect with Hubex:

Step-1: Select Method

  1. After subscribing to Hubex, you will receive an email with the link to Hubex API documentation and the relevant API and the sandbox key. API key is used to call methods on live environment whereas sandbox key is used for testing purposes.

  2. Hubex API documentation consists of the following details.

    • Method
    • Endpoint Details
    • Request and Response Schemas
    • Authorization details
    • Example / Sample payloads

  3. Your API key is linked to your subscription and is required for calling any of the Hubex methods.

  4. Your Sandbox key is linked to your subscription as well but used for testing purposes.

  5. You can search for a specific method or keyword using the search control available on the top left column.

Step-2: Call Method

Run in Code

  1. After selecting a method, copy the endpoint URL from the right column of API documentation.

  2. Identify the RESTful API method e.g POST, GET, PUT, DELETE etc from endpoint URL.

  3. Click 'Run in Postman' which will open the Postman request of the respective method.

  4. Select the code snippet of your desired language from the right-side navigation of postman UI.

  5. Replace the API-key in the code snippet with the API-key provided in the Welcome email received when subscribing.

  6. You are required to include the API key header manually as shown below:

    >> x-api-key = [Your-API-Key]

  7. The request schema for the method is shown in the middle column and the request payload (example) is given in the right column.

  8. After providing the API key, request body and RESTful method with the endpoint details, you would be able to execute and receive a response.

Run in Postman

  1. The request can be executed within the Postman UI as well by forking the Hubex collection and updating the x-api-key header in the collection variables.

  2. Make sure to log-in to your Postman account before clicking the 'Run in Postman' button or login afterwards.

  3. Right click the Hubex Collection and click 'Create a Fork'.

  4. Postman's 'Create a Fork' screen will appear, before Forking the collection, please make sure to select 'Watch original collection' checkbox to enable 'Pull Changes' function to receive collection updates.

  5. After the Collection is forked/created in your Postman Workspace, please update the Collection variable(s) "x-api-key" and others based on the values/keys provided.

  6. All requests are configured to use their collection variables.

Step-3: Method Response

  1. Once you call the method, following are the possible types of responses statuses:

    1. 200 - Success
    2. 400 - Bad Request
    3. 401 - Authorization information is missing or invalid
    4. 422 - Validation Error
    5. 500 - Internal server error

  2. For each of the response statuses the response schemas are given in the method details.

  3. All responses are in JSON format

For Complete Hubex API Documentation Click Here (opens in a new tab).

OverviewFAQs