API Manager

The API Manager allows teams to define, document, test, and reuse APIs in a structured and secure way across projects, test cases, and automation flows.
It acts as the single source of truth for how APIs behave, how they are authenticated, and how they should be validated.

Why it matters

• Centralizes all API definitions in one place instead of scattering them across test cases

• Reduces duplication and inconsistencies when APIs change

• Enables secure, controlled API testing with built-in validation and limits

When to use it

• When your project relies on backend or third-party APIs

• When APIs are reused across multiple test cases or test plans

• When you need controlled, auditable API testing without external tools

Core concepts

• APIDefinition – A full description of an API endpoint (method, auth, parameters, schemas)

• APIParameter – A structured definition of inputs (path, query, header, body, cookie)

• API Execution – Manual or automated execution with response tracking

• API Metadata – Schemas, examples, error codes, notes, and retry rules

How it works

• User defines an API with endpoint, method, and authentication

• Parameters are added with clear locations and rules

• API can be tested directly from the manager

• The same API is reused later inside test cases and automation

How to use it

Step 1: Create a new API Definition
Fill in endpoint, HTTP method, authentication type, and timeout.

Step 2: Define parameters
Add parameters and specify where each one lives (path, query, header, body).

Step 3: Add schemas and examples
Document request/response structure and expected error codes.

Step 4: Test the API
Run the API safely and inspect status, duration, size, and response data.

Best practices

• Keep one API definition per real endpoint

• Use parameters instead of hardcoded values

• Always document example responses and error codes

Common mistakes

❌ Creating duplicate APIs for the same endpoint
✔ Keep a single definition and reuse it everywhere

❌ Hardcoding tokens or IDs inside test cases
✔ Define them as parameters or defaults in the API Manager

Security & permissions

• APIs are strictly scoped to the active project

• Unsafe or internal URLs are automatically blocked

• Authentication secrets are stored encrypted

Related documentation

• Test Case – API usage

• Smart Agent – API execution

• Security – Project overview