> For the complete documentation index, see [llms.txt](https://docs.mmoweb.biz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mmoweb.biz/rest-api/vvedenie-v-api-v2.md).

# Введение в API v2

### Что такое API?

API (прикладной программный интерфейс) — набор правил и форматов для обмена данными и вызова операций между приложениями. Через API одно приложение может безопасно запрашивать данные у другого или отдавать ему команды для выполнения задач.

API MMOWeb v2 предоставляет программный доступ к возможностям платформы: управлению мастер-аккаунтами, балансами, платежами и другим сущностям, необходимым для интеграции и автоматизации.

***

### Основные параметры

* **Base URL:** `https://api.mmoweb.biz/`
* **Версионирование:** версия указывается в пути (например, `/v2`)
* **Формат данных:** JSON
* **Методы:** большинство endpoint'ов использует POST; некоторые — GET с query-параметрами
* **Аутентификация:** Application Token

***

### Принципы запросов и ответов

* Формат ответа — JSON. В каждом ответе присутствует поле:
  * `success` (boolean) — `true`, если операция выполнена успешно.
* Структура успешного ответа зависит от конкретного endpoint'а и описывается в его документации.
* Ошибки возвращаются в виде JSON с полями `success: false`, `code` и `message`.

***

### HTTP-статусы

Ниже приведены наиболее часто встречаемые коды ответов. Для полного списка статусов и специфичных для конкретного endpoint'а кодов обратитесь к его документации.

<table data-search="false"><thead><tr><th>Код</th><th>Значение</th><th>Описание</th></tr></thead><tbody><tr><td><code>200</code></td><td>OK</td><td>Запрос успешно обработан</td></tr><tr><td><code>400</code></td><td>Bad Request</td><td>Ошибка в параметрах или валидация не пройдена</td></tr><tr><td><code>401</code></td><td>Unauthorized</td><td>Отсутствует или неверен токен аутентификации</td></tr><tr><td><code>403</code></td><td>Forbidden</td><td>Недостаточно прав или доступ запрещён</td></tr><tr><td><code>404</code></td><td>Not Found</td><td>Ресурс или endpoint не найден</td></tr><tr><td><code>409</code></td><td>Conflict</td><td>Конфликт состояния (например, ресурс уже существует)</td></tr><tr><td><code>422</code></td><td>Unprocessable Entity</td><td>Ошибки при пакетной обработке или валидации данных</td></tr><tr><td><code>500</code></td><td>Internal Server Error</td><td>Ошибка на сервере</td></tr></tbody></table>

{% hint style="info" %}
При обработке ошибок всегда опирайтесь на документацию конкретного endpoint'а, так как там могут быть описаны дополнительные коды и особенности их обработки.
{% endhint %}