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

# Postman collection and environment for STE Hosted API

> Test the hosted STE API with a ready-made Postman collection and environment, including payCalcRequest examples for federal, state, city, county, and multi-state scenarios.

Use the Postman collection to explore every hosted STE API endpoint without writing code. Pair it with the environment file so requests pick up the right base URLs and your API key.

<Note>
  The hosted STE API serves both files from `/postman` endpoints, so you always pull the current copy rather than a saved snapshot.
</Note>

## Download the files

The collection contains sample requests to all endpoints, along with `payCalcRequest` examples for federal, state, city, county, and multi-state scenarios. Additional examples for specific wage types and benefits are included as well. The environment file provides the variables used across those requests.

| Endpoint                   | Returns                                                                  |
| -------------------------- | ------------------------------------------------------------------------ |
| `GET /postman/collection`  | The STE Hosted Examples collection as JSON.                              |
| `GET /postman/environment` | An environment file for the deployment you called, chosen automatically. |

Both endpoints take the same credentials as every other hosted STE endpoint: your API key, plus a US or Canada STE license. A request carrying no license returns `403`, and if the packaged file cannot be loaded the endpoint returns `500` rather than an empty `200`.

```http theme={null}
GET /postman/collection HTTP/1.1
Host: ste.symmetry.com
Authorization: your_api_key_here
Accept: application/json
```

You can also call both from the [Swagger docs page](https://ste.symmetry.com/ste-hosted/docs#/), under the **Postman** section near the end of the page: select **Authorize**, then **Try it out**. The collection renders in the response body rather than arriving as a file download, so save it from there.

## Import into Postman

<Steps>
  <Step title="Get both files">
    Call both endpoints and save each response.
  </Step>

  <Step title="Import both files into Postman">
    In Postman, select **Import**, then add the collection file and the environment file you downloaded.
  </Step>

  <Step title="Select the environment and set your credentials">
    Activate the environment, then supply your own `apiKey` and point the endpoint URLs at the environment you're testing against.
  </Step>
</Steps>

## Environment variables

Set these three variables for the environment you're testing against. An environment fetched from `GET /postman/environment` already has `endpointURL` and `endpointURLV2` filled in for the deployment you called it on, and ships with `apiKey` blank, so your key is the only value you need to supply.

| Variable        | Staging                                           | Production                                |
| --------------- | ------------------------------------------------- | ----------------------------------------- |
| `apiKey`        | Your staging API key                              | Your production API key                   |
| `endpointURL`   | `https://ste-staging.symmetry.com/ste-hosted/v1/` | `https://ste.symmetry.com/ste-hosted/v1/` |
| `endpointURLV2` | `https://ste-staging.symmetry.com/ste-hosted/v2/` | `https://ste.symmetry.com/ste-hosted/v2/` |

<Note>
  Staging and production use **separate** API keys. If you don't know your API key, open a ticket with Client Success and we'll be happy to help.
</Note>

## Prefer an interactive explorer?

The [STE Hosted API overview](/ste/api-reference/overview) links to the live Swagger UI for both production and staging, where you can authorize with your key and execute requests directly in the browser.