Skip to main content

API Management

The API Management module in DxConnect allows you to define, test, and interact with external APIs directly from the platform. This is especially useful for integrating third-party services, fetching dynamic data, or customizing workflows with live API calls.

Overview​

The interface is divided into the following main areas:

  • Sidebar (left): List and manage your saved APIs.
  • Editor Panel (center/right): Configure request type, endpoint, parameters, and view responses.
  • Environment Selector (top-right): Choose between environments such as Development or Production.

Add a New API​

  1. Click the Add API button.
  2. Give the API a unique name.
  3. Choose the HTTP method (GET, POST, etc.).
  4. Enter the request URL.
  5. Configure parameters, headers, or request body as needed.
  6. Click Save to store the API definition.

Editing API Configuration​

URL Configuration​

Define the full URL including query parameters. You can use templating syntax like:

https://your-domain/api/get?type_room={{{room_code}}}&style_room={{{style_code}}}

These placeholders ({{{room_code}}}, {{{style_code}}}) will be replaced dynamically by the values you set in the Params tab.

HTTP Methods Supported​

  • GET – Retrieve data from a service.
  • POST – Submit data to a service.
  • (More methods like PUT, PATCH, DELETE may also be supported.)

Tabs Breakdown​

Params Tab​

Add query parameters to your request:

KeyValue
type_room{{{room_code}}}
style_room{{{style_code}}}

These will be automatically appended to the URL during execution.

Headers Tab​

Define any necessary request headers such as:

  • Authorization: Bearer <token>
  • Content-Type: application/json

Body Tab​

Used primarily for POST, PUT, or PATCH methods where a request body (typically in JSON) is required.

Scripts Tab (Optional)​

Add scripting logic to pre-process input or post-process responses if supported.

Executing the API Call​

Once your API is configured:

  1. Click the Send button.
  2. Wait for the response to appear in the Response section.
  3. The result (JSON, text, etc.) will be displayed in a formatted preview below.

You can use this to validate integrations or test data sources in real time.

Response Viewer​

  • The bottom section shows the API response.
  • You can expand, scroll, and inspect the returned data structure.
  • Helpful for debugging issues with your API configuration.

Environment Switching​

Use the dropdown in the top-right corner to switch between:

  • Development
  • Production

This is useful for testing in sandbox vs. live environments without needing to reconfigure your APIs.

  • View all saved API definitions.
  • Click the 🖊️ (edit) icon to modify an API.
  • Click the 🗑️ (delete) icon to remove an API.

Best Practices​

  • Keep your API names descriptive (e.g., API_get_color).
  • Use clear parameter names and dynamic variables for reusability.
  • Validate API responses before integrating with workflows or UI.
  • Secure your production APIs using headers and authentication where required.

Example: API_get_color​

FieldValue
MethodGET
URLhttps://.../get-colour-available?type_room={{{room_code}}}&style_room={{{style_code}}}
Paramstype_room, style_room
ResponseAppears in the lower panel

This API retrieves available color options for a specific room type and style.