Введение в 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'а кодов обратитесь к его документации.

Код	Значение	Описание
200	OK	Запрос успешно обработан
400	Bad Request	Ошибка в параметрах или валидация не пройдена
401	Unauthorized	Отсутствует или неверен токен аутентификации
403	Forbidden	Недостаточно прав или доступ запрещён
404	Not Found	Ресурс или endpoint не найден
409	Conflict	Конфликт состояния (например, ресурс уже существует)
422	Unprocessable Entity	Ошибки при пакетной обработке или валидации данных
500	Internal Server Error	Ошибка на сервере

При обработке ошибок всегда опирайтесь на документацию конкретного endpoint'а, так как там могут быть описаны дополнительные коды и особенности их обработки.