> For the complete documentation index, see [llms.txt](https://docs.rtkdata.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rtkdata.com/enterprise-portal/api.md).

# Enterprise API: Connect Your Own Systems with API v2

Connect your own systems to your RTKdata Enterprise account with API v2: keys, webhooks, the test sandbox and what differs for Enterprise accounts.

The **API** lets your own software do what you do in the portal: create device logins when equipment is registered in your own systems, follow your fleets, read invoices and sessions, and react to events as they happen.

![The API area](https://3957820804-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJflLSSoC9TU9MkwT5lbC%2Fuploads%2Fgit-blob-c09a51109bb165bdbdaa23077215e9c252b827df%2Fenterprise-api.png?alt=media)

> The API is optional and has to be enabled for your account by RTKdata. Until then, the **API** area in your sidebar says so. Ask your RTKdata contact or <support@rtkdata.com> if you want it switched on.

***

## Enterprise accounts use API v2

Enterprise accounts work with **API v2** at `https://enterprise.rtkdata.com/v2`. API v1 is not available for them. Your key decides which account you reach.

**API > Docs** is the reference for your account: it is generated from the API itself and shows only what applies to an Enterprise account, with a working curl per endpoint, its fields and its errors. **Build with AI** on that page downloads the whole reference as one Markdown file for your AI coding assistant.

The [Enterprise API v2 guide](https://docs.rtkdata.com/enterprise-portal/api/api-guide.md) explains the concepts, the rules every call follows and every endpoint. The [error catalogue](https://docs.rtkdata.com/enterprise-portal/api/api-guide/api-errors.md) explains every refusal.

***

## What your account can do

| Topic                   | How it works on your account                                                                                                                                                                    |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **No customer records** | Your logins belong to your account directly, there is no customer in between                                                                                                                    |
| **Devices and fleets**  | A license carries `credentialType` (`device` or `fleet`) and, for a fleet, its `contingentId`                                                                                                   |
| **Stream contingents**  | Buy, top up and renew contingents and create fleets from them, under **Contingents** in the reference. Contingents have their own events, such as `contingent.created` and `contingent.renewed` |
| **Your products**       | `GET /v2/account/products` lists the products agreed for your account. Pass `productId` when you buy                                                                                            |
| **Archive**             | `archive` and `unarchive` work as in the portal, with `license.archived` and `license.unarchived` events. `archivedAt` shows the state                                                          |
| **Tags**                | Manage tags under `/v2/tags`, assign them in bulk, and filter lists with `tagId`                                                                                                                |
| **Trials**              | You cannot start a trial on your own, the API follows the same rule as the portal. In the sandbox, `POST /v2/test/trial-contingents` gives you trial streams to rehearse with                   |
| **Account conditions**  | What your contract rules out in the portal is refused here too, with `not_available_for_account`. `GET /v2/account/capabilities` tells your software what is possible up front                  |

***

## Keys, webhooks and requests

The tabs of the API area:

* **Overview**: tiles for calls, error rate, latency and pending operations, plus a **Go-live readiness** checklist that ticks itself off as you progress.
* **Keys**: **Test** and **Live** keys, each with its scopes, expiry and IP allowlist. Only a short preview is shown after creation. Creating and revoking keys needs the **API: Manage** right, see [Team & Rights](https://docs.rtkdata.com/enterprise-portal/team.md).
* **Webhooks**: endpoints in your systems that hear about what happens, signed so your handler can verify them. Webhooks on an Enterprise account always use the v2 payload.
* **Events** and **Requests**: every event your account produced and every call your keys made. Quote the request id when you contact support.

***

## The test sandbox

**Enter test sandbox** at the top right switches the API area to your test data. A test key (`rtk_test_...`) never touches a real caster account or invoice, and it only sees test data. **API > Test data** shows everything your test keys created. Test and live data never mix, and an id from the other environment answers 404.

***

## Suggested integration order

1. Create a **test** key, and make a first call with an `Idempotency-Key`.
2. Register a webhook endpoint, pick its event types, and send a test event until it reports **Active**.
3. Rehearse your flows in the sandbox, including what your software does when a call is refused.
4. Create a **live** key with only the scopes your integration needs, and give it an expiry or an IP allowlist.
5. Switch your production system over, and revoke anything you no longer use.

***

## Next

* [Enterprise API v2 guide](https://docs.rtkdata.com/enterprise-portal/api/api-guide.md)
* [Enterprise API v2 error catalogue](https://docs.rtkdata.com/enterprise-portal/api/api-guide/api-errors.md)
* [Devices](https://docs.rtkdata.com/enterprise-portal/devices.md) and [Fleets & Contingents](https://docs.rtkdata.com/enterprise-portal/fleets.md): the same lifecycle, done by hand


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.rtkdata.com/enterprise-portal/api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
