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

Import the demo Postman collection

The sample collection is stored in the API repository:

https://github.com/idelium/idelium-api/blob/main/testfile/postman/Postman%20Echo.postman_collection.json

In Idelium Web:

1. Open Steps.
2. Create a new step.
3. Select the Postman step type.
4. Upload the Postman collection.
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

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: