> ## Documentation Index
> Fetch the complete documentation index at: https://docs.valedo.uniwave.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Postman

> Collection and environments for calling the Valedo APIs.

The collection is `postman/valedo-api.postman_collection.json`. It covers the health endpoints and the implemented Valedo.API and Publisher API endpoints documented in the [API reference](https://docs.valedo.uniwave.ai/developers/api-reference.md). It holds no variables. Every value that changes between environments lives in an environment file.

## Files

| File | Purpose |
| - | - |
| `postman/valedo-api.postman_collection.json` | Requests for both hosts, bearer auth from `{{accessToken}}` |
| `postman/valedo-local.postman_environment.example.json` | Local hosts (`https://localhost:7101`, `7102`) |
| `postman/valedo-dev.postman_environment.example.json` | Dev hosts: Valedo.API on `https://dev.valedo.uniwave.ai`, Publisher API on its `azurewebsites.net` host (placeholder `<prefix>`) |

Copy an example environment, fill in the placeholders, and save the copy under a name that is gitignored (for example `valedo-dev.postman_environment.json`). Only `*.example.json` files are committed.

## Variables

| Variable | Type | Set by |
| - | - | - |
| `baseUrl` | default | Valedo.API base URL |
| `publisherBaseUrl` | default | Publisher API base URL |
| `tenantId`, `clientId`, `scope` | default | Entra app registration values |
| `senderAddress` | default | Sender mailbox for the reply example |
| `accessToken` | secret | Obtain a token for your test tenant; never commit it |
| `publisherAccessToken` | secret | Obtain a token for the Publisher API audience; never commit it |
| `templateId`, `templateETag`, `ruleId`, `ruleETag` | default | Resource IDs and ETags saved while running the collection |
| `eventId` | default | Marketplace operation ID used by `/api/publisher/marketplace-events/{eventId}` |
| `marketplaceSubscriptionId`, `marketplaceWebhookToken` | default / secret | Marketplace webhook test values; never commit a token |

## Keeping it current

When an endpoint is added or changed, update the collection in the same change, then the API reference page. The collection must not gain collection-level variables; check with `jq '.variable' postman/valedo-api.postman_collection.json`, which should print `null`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.