Building a Postman Collection
Prerequisites
Prerequisites
Download and install Postman (free). Have your Aelix API key or OAuth credentials ready.
Step 1 — Create an Environment
In Postman, click Environments → Create Environment and add these variables:
| Variable | Value | Type |
|---|---|---|
| baseUrl | https://api.aelix.digitalapi.ai | default |
| apiKey | (your key) | secret |
| clientId | (your client_id) | secret |
| clientSecret | (your client_secret) | secret |
| accessToken | default (auto-populated) |
Step 2 — Import the Collection
Download the official Aelix Postman collection from the Developer Portal under Documentation → Downloads → Postman Collection, or use the public link:
https://aelix.digitalapi.ai/postman/aelix-apis-v1.json
In Postman, click Import → Link and paste the URL.
Step 3 — Set Up Auto-Authentication
The collection includes a pre-request script that automatically fetches and caches an access token. To enable it, set your clientId and clientSecret in the environment you created in Step 1.
Step 4 — Send Your First Request
Expand the collection, open ATM Locator → Search ATMs by Postcode, ensure your environment is active, and click Send. You should see a 200 response with nearby ATM data.
Exporting for CI/CD
Use Newman to run your Postman collection in automated pipelines:
npm install -g newman
newman run aelix-apis-v1.json \
--environment aelix-prod.json \
--reporters cli,junit \
--reporter-junit-export results.xml