API Management

The API Management feature is a built-in, Postman-style workspace inside Global Configurator. You can group API requests into suites, configure every detail of each request, import from cURL, run requests, and review your execution history — all in one place, with no external tools required.

What Is API Management?

Think of it as a lightweight Postman that lives inside the platform. You create API Suites (like Postman collections) to organize related requests, then build individual API Requests inside each suite. Once saved, any request can be re-run, shared with teammates, or exported as a cURL command.

API Suites

An API Suite is a named container for a group of related API requests.

Examples of how teams name their suites:

• Customer Service APIs — all calls to a CRM system
• Finance Reporting APIs — endpoints used in month-end reports
• ERP Integration — requests for an ERP connector

Creating a Suite

1. Open Global Configurator and navigate to the API section.
2. Click New Suite, enter a unique name, and optionally add a description.
3. Save the suite — it will appear in the suites list immediately.

You can also clone an existing request from one suite into another, which saves time when two suites share similar calls.

tip

Suite names must be unique. Use clear, descriptive names so teammates can tell at a glance what a suite covers.

API Requests

An API Request is an individual HTTP call saved inside a suite. Every detail needed to run the request — method, URL, headers, body, query parameters, authorization, and variables — is stored with it, so you never need to remember or rebuild it.

Creating a Request

1. Open a suite and click New Request.
2. Give the request a name (unique within the suite).
3. Fill in the request details (see the table below).
4. Save — the request is stored and ready to run.

Request Fields

Field	What to enter	Example
Name	A friendly label for this request	Get Customer Details
HTTP Method	The action to perform	GET, POST, PUT, PATCH, DELETE
URL	The full API endpoint	https://api.company.com/v1/customers
Headers	Key-value pairs sent with the request	Content-Type: application/json
Body	Data payload (for POST / PUT requests)	JSON or form data
Query Parameters	URL parameters appended to the endpoint	status=active&limit=50
Authorization	How this API authenticates	Bearer Token, OAuth 2.0, etc.
Variables	Request-scoped placeholders	baseUrl, customerId

note

Request names must be unique within their suite. Two suites can each have a request called Get Status, but within one suite each name must be different.

Typical Workflow

Create a Suite

Group requests by system, team, or purpose

Add Requests

Configure method, URL, headers, body, and auth for each call

Configure and Save

Set variables and authorization so the request is ready to run

Execute

Run the request and inspect the response

View Results

Review execution history for past runs

Build once, run as many times as you need — results are always logged in Execution History.

Authorization Types

Global Configurator supports all common API authentication methods. Choose the right one when setting up a request:

Authorization Type	When to use it
None	The API is public and requires no authentication
Basic Auth	The API accepts a username and password
Bearer Token	The API uses a JWT or a static token in the Authorization header
API Key	The API expects a custom key, usually in a header or query parameter
OAuth 2.0	The API uses the full OAuth 2.0 flow (client credentials, authorization code, etc.)
Digest Auth	Older systems that require MD5-hashed credentials

Authorization configurations can be saved by name and reused across requests. You can also check whether a named authorization config already exists before creating a new one, which avoids duplicates.

info

OAuth 2.0 configurations are stored securely and referenced by name, so credentials are not copied into every request that uses them.

cURL Import and Export

Importing from cURL

If you already have a cURL command (copied from browser developer tools, documentation, or a colleague), you can paste it directly into the import field. The platform parses it automatically and creates a fully configured request — method, URL, headers, and body are all extracted for you.

How to import:

1. Open a suite and choose Import from cURL.
2. Paste the cURL command into the text field.
3. The platform fills in all the request fields.
4. Review and save.

Exporting as cURL

Any saved request can be converted back to a cURL command.

How to export:

1. Open the request you want to share.
2. Click Generate cURL.
3. Copy the generated command.

This is useful for sharing a request with a developer who uses a terminal, or for pasting it into API documentation.

tip

Use cURL import to quickly onboard API examples shared in documentation or by vendors — no manual copy-paste of individual fields needed.

Request Variables

Variables let you parameterize a request so it works in different situations without editing the URL or body each time.

• Variables are scoped to the request — they exist only within the request where they are defined.
• Each variable has a name that must be unique within the request.
• Reference a variable inside the URL, headers, or body by wrapping its name in the appropriate syntax.

Common uses for variables:

Variable name	What it holds	Example value
baseUrl	The root URL so you can swap environments	https://api.company.com
customerId	An ID passed into the endpoint path	CUST-00123
authToken	A token used in the Authorization header	A bearer token string
pageSize	A query parameter value	25

Variables support full CRUD management (create, read, update, delete) from the request detail view.

note

Request variables are scoped only to their own request. They are not shared across other requests in the suite.

Execution History

Every time a request is executed, the result is recorded. The Execution History page lets you page through past runs with filters to find what you need.

What history captures:

• Which request was run and when
• The HTTP status code returned
• The full response (including response body)
• Any files returned by the API (downloadable as artifacts from S3 storage)

Downloading response artifacts: If an API execution returned a file (such as a report or an export), you can download it directly from the history entry — no need to re-run the request.

tip

Use Execution History to troubleshoot a request that worked last week but is failing today. Compare the response body across runs to spot what changed.

RBAC Permissions

Access to API Management is controlled by role-based permissions:

Permission	What it allows
GlobalConfigurator:ApiSuite:read	View suites and their contents
GlobalConfigurator:ApiSuite:upsert	Create and edit suites
GlobalConfigurator:ApiSuite:delete	Delete suites
GlobalConfigurator:ApiRequest:read	View saved requests
GlobalConfigurator:ApiRequest:upsert	Create and edit requests
GlobalConfigurator:ApiRequest:delete	Delete requests
GlobalConfigurator:ApiRequest:import	Import requests from cURL

Contact your platform administrator if you need access to any of these actions.

Tips and Common Questions

Name things clearly

Suite and request names are visible to your whole team. Names like Get Customer by ID are much easier to work with than Test1 or New Request.

Do not store production secrets in request bodies

Use variables or saved authorization configurations instead of pasting credentials directly into headers or body fields. This keeps sensitive values managed in one place and out of plain text.

Script editor

The Suite Details page includes a Monaco editor (the same editor used in VS Code) for writing scripts that can accompany a suite. This is useful for documenting the suite or adding lightweight pre/post logic.