---
title: Introduction
slug: wyyM-introduction
docTags: 
createdAt: 2024-07-11T10:05:50.645Z
---

:::hint{type="warning"}
**Warning: Draft Documentation Only**

This documentation is currently in draft status. The system is under active development and some details may change over time. Where significant changes are anticipated, these will be highlighted with a callout block.
:::

# Basic API information

## Environments

There are two environments available for integrators:

- Live (production environment)
- Sandbox (testing environment used during integration)

Please note the following:

- Credentials issued for one environment are not valid in other environments
- Live cards should only be used in the live environment
- Test cards should **never** be used in the live environment

The base URLs for each environment are:

Live environment: `https://mgmt-api.torogateway.com`

Sandbox environment: `https://mgmt-api.torogateway.dev`

## OpenAPI/Swagger Documentation

The documentation is served as JSON at [mgmt-api.torogateway.dev/v1/docs](https://mgmt-api.torogateway.dev/v1/docs) and via a Swagger UI at [mgmt-api.torogateway.dev/v1/swagger-ui](https://mgmt-api.torogateway.dev/v1/swagger-ui). These endpoints are protected by Basic Auth, using the same password as this Archbee documentation and user `user`.

## Data format

Request payloads must be formatted as JSON (Content-Type: `application/json`). 

## Versioning

Endpoint URLs include a major version number (e.g. `/v1`).

## Rate limiting

To prevent abuse, rate limiting is enforced. If the rate limit is exceeded, response with status code 429 TOO MANY REQUESTS will be sent.

## Authentication

All API requests must be made over HTTPS. Requests made over plain HTTP will fail. API requests without authentication will also fail.

Authentication can be achieved by setting a valid API-Key header or by authenticating and receiving a JSON Web Token (JWT) via the `/tokens` endpoint.

Please see the OpenAPI/Swagger documentation for full details

## Data Structure

To help integrators visualise the relations between different entities in our system, here is a diagram showing the major entity types:

![](https://api.archbee.com/api/optimize/NWfX_cs_B_73KTvNy1ETb/I77rZxl42hla3Q_iC-CIK-20251015-130448.png)