# Installation

## Prerequisites

- Access to the **Fleet cockpit** for your workspace, with rights to create or rotate **Platform API** credentials.
- **HTTPS** from the environment where your integration runs.

## Get a platform API key

1. Sign in to the **Fleet cockpit**.
2. Open the area where **Platform API** (or automation API) keys are managed.
3. Create a credential and copy the **secret** once; store it in a secret manager or environment variable—never commit it to source control.
4. Check the key’s **scope**: **READ** (read-only) or **WRITE** (required for creating or changing carts, users, devices, and for validating carts).

Rotate or revoke keys from the same place if a secret is exposed.

## Base URL

| Environment | Host | Path prefix |
|-------------|------|-------------|
| Production | `https://api.fleet.co` | `/platform/v1` |
| Other (staging, sandbox) | Use the host Fleet provides | `/platform/v1` |

## First request

Use any **GET** operation from the **API reference** (for example listing users or devices with `limit=1`). Send:

- Header **`Authorization: Bearer <your_secret>`**
- Query **`limit`** / **`offset`** where the operation supports pagination

A successful read returns **200** and JSON with a **`data`** object or array (and **`meta`** for paginated lists). Wrong or revoked secrets typically yield **401**.

## Explore the API

Use **API reference** for copy-pasteable paths, bodies, and response shapes. Some builds also expose Markdown siblings for each operation (see this repo’s `README` if you generate API Markdown locally).

## Next steps

- [Authentication & scopes](./authentication/) — scopes and rate limits.
- [Requests & responses](./requests-and-responses/) — envelopes and errors.
- The resource guides for how **catalog**, **carts**, **devices**, and **users** fit together.