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

# Postman

> Try the wede API in Postman with the contract the API publishes

The wede API publishes its contract in OpenAPI 3.1 at:

```text theme={null}
https://api.wede.pt/docs/json
```

This is the same contract the API is built and tested against, so a collection imported from it always matches the current API. Import it again whenever the [changelog](/changelog.md) announces new endpoints.

## Import the collection

1. In Postman, choose **Import** and paste `https://api.wede.pt/docs/json`.
2. Import it as a Postman collection. Every endpoint appears in a folder named after its area (Events, Sync, Webhooks, Teams and others).
3. Open the collection's **Variables**. `baseUrl` is `https://api.wede.pt/v1`, the address for production and sandbox: the environment follows your credential, not the address.

## Add your credential

Start with a sandbox key (`wede_test_`): nothing it sends reaches a real recipient or counts toward usage. See [Environments](/api-reference/introduction.md#environments).

**API key** (events, sync, webhooks, connectivity, zones and account endpoints):

1. On the collection, open **Authorization** and choose **API Key**.
2. Key `x-wede-api-key`, value your key, add to **Header**.
3. Requests set to **Inherit auth from parent** use it.

**Session token** (teams, dispatch, missions, users and other endpoints a user's role grants):

1. Send `POST /auth/login` with your email and password.
2. Copy `token` from the response.
3. On the collection, choose **Bearer Token** and paste it. It is valid for 8 hours.

If a request carries both, wede uses the session token.

## First requests

| Request | What it shows |
| - | - |
| `GET /tenant/me` | Your organisation, zones and settings |
| `GET /catalog` | The event types you can send |
| `POST /events` | Sends an event. Set a new `idempotency_key` for each one |
| `GET /events/{event_id}` | The event and its lifecycle |
| `POST /sandbox/simulate-connectivity` | Takes a zone offline in the sandbox, so you can see the fallback |

The [quickstart](/quickstart.md) walks through the same steps with curl.

> [!WARNING]
>
> Never share a collection or a Postman environment that contains a key or a token. Keep credentials in Postman's secret variables or in your local environment only.


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