Quick Start Test API Using Postman

Quick Start Test API Using Postman

This guide walks through a first API test cycle using a Postman collection.

Before you begin

Start the demo stack with Start IAS, then sign in with the generated demo or administrator identity stored in the ignored secrets/ files.

Install Idelium CLI on the machine that will execute the test:

python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install idelium

Idelium CLI supports two Postman execution modes:

• postman_safe, the default Python runner for deterministic request execution without arbitrary Postman scripts.
• postman_newman, an optional Newman-backed runner for full Postman runtime compatibility, including pm.test, pre-request scripts, test scripts, environment files, and iteration data.

Install Newman only when your collection requires the full Postman runtime:

npm install --global newman

The Docker stack does not add Newman to the base API/Web/DB services. Run Newman from the CLI host or from an explicit runner profile so execution infrastructure remains separate from the administration stack.

Import the demo Postman collection

The sample collection is stored in the Docker repository together with the other quick-start examples:

https://github.com/idelium/idelium-docker/blob/main/docs/examples/Postman%20Echo.postman_collection.json

In Idelium Web:

1. Open Steps.
2. Create a new step.
3. Select the Postman step type.
4. Upload docs/examples/Postman Echo.postman_collection.json, or download it directly from GitHub using the raw URL: https://raw.githubusercontent.com/idelium/idelium-docker/main/docs/examples/Postman%20Echo.postman_collection.json.
5. Save the step.

Create a test

1. Open Tests.
2. Create a new test.
3. Add the Postman step to the test.
4. Fill in the required name and description.
5. Save the test.

Create a test cycle

1. Open Test Cycles.
2. Create a cycle for the Postman test.
3. Fill in the required cycle fields.
4. Save the cycle and note its identifier.

Configure the CLI key

Download the API key from Idelium Web and store it in the protected key file:

install -m 600 /dev/null ~/.idelium

Copy the key into ~/.idelium using a secure editor or secret-management tool. Do not print it or pass it directly in shell history.

Run the cycle

Use the project and cycle identifiers from your local instance:

idelium \
  --idProject=<project-id> \
  --idCycle=<cycle-id> \
  --environment=demo \
  --ideliumwsBaseurl=https://localhost

For uploaded steps that declare runtime: "postman_newman", the CLI writes temporary collection, environment, and iteration-data files, executes Newman, and maps the JSON report back to Idelium performed-step results. Bound Newman execution time with:

idelium \
  --idProject=<project-id> \
  --idCycle=<cycle-id> \
  --environment=demo \
  --ideliumwsBaseurl=https://localhost \
  --postmanNewmanTimeout=300

If Newman is missing from PATH, the step fails safely with a clear result instead of crashing the CLI process.

Review results

In Idelium Web, open Test Performed and select the completed cycle.

Open the test result and select Postman Collection Details:

Review each request result inside the collection:

Result and secret handling

Both Postman modes return Idelium performed-step results. The Newman runtime maps request name, method, URL, status, timing, assertion failures, script failures, malformed reports, and Newman exit codes to pass/fail status.

Before results are stored, the CLI redacts common sensitive values in URL query parameters and JSON response fields, including tokens, cookies, passwords, secrets, sessions, and authorization values. Do not include real API tokens, session cookies, or passwords in screenshots or shared collection examples.