Руководство:
Начало работы

Lesta Games Public API — набор общедоступных методов API, которые предоставляют доступ к проектам Lesta Games, включая игровой контент, статистику игроков, данные энциклопедии и многое другое.

Перед началом работы с Lesta Games Public API, ознакомьтесь с условиями использования и документацией.

Чтобы просмотреть результаты, возвращаемые методами API, используйте API Explorer. Например, API Explorer может имитировать работу метода для поиска игрока по заданным критериям или работу метода для просмотра профиля игрока.

Кабинет разработчика

Кабинет разработчика предоставляет необходимую информацию для разработки собственных продуктов и сервисов на основе методов API.

Чтобы войти в кабинет разработчика и начать работу с Lesta Games Public API, авторизуйтесь, используя аккаунт Lesta Games.

Регистрация приложения

Чтобы зарегистрировать приложение в кабинете разработчика:

• Войдите в кабинет разработчика.
• Перейдите в раздел Мои приложения.
• Нажмите Добавить приложение. На экране появится форма для регистрации приложения.
• Выберите тип приложения. См. Типы приложений.
• Введите название приложения. Когда произведён вход в приложение, его название будет отображено на странице «Сеансы» в «Личном кабинете» пользователя.
• Нажмите Добавить приложение. На экране появится список добавленных приложений.
• После успешной регистрации приложения вы получите ключ (application_id), который является идентификатором вашего приложения для обращения к API.

Использование application_id

application_id — идентификатор приложения, который используется при отправке запросов. Только с помощью application_id ваше приложение может получить доступ к полному контенту Lesta Games.

Доступ к контенту предоставляется в формате JSON.

Для каждого идентификатора существует квота на количество выполняемых запросов.

Формат запроса

API предоставляет данные посредством обращения по протоколу HTTP(S) к специальному домену/поддомену, который соответствует игровому кластеру.

Часть доменного имени, указывающая на кластер, обозначается <server>.

Поддерживаются два способа передачи параметров:

1. Методы GET: вводятся в URL запроса.
   Пример: ?<param_name>=<param_value>
2. Методы POST: вводятся в теле HTTP запроса.
   Пример: ?<param_name>=<param_value>

Все запросы в URI-формате имеют следующий вид:

http(s)://<server>/<API_name>/<method block>/<method name>/?<get params>Где:

• <server> — URI игрового сервера на соответствующем кластере
• <API_name> — версия API
• <method block> — название группы методов
• <method name> — название метода
• <get params> — параметры метода GET для запроса

Любые текстовые параметры необходимо передавать в кодировке UTF-8.

При каждом вызове методов API могут передаваться следующие параметры:

Для предотвращения использования access_token злоумышленниками запросы, которые содержат access_token, следует отправлять по защищённому соединению HTTPS.

В некоторых методах используется параметр extra. Он предназначен для перечисления списка экстра полей, которые будут включены в ответ. По умолчанию, экстра поля исключены из ответа. Списки доступных экстра полей для каждого метода перечислены в документации метода в Справочнике API. См. пример.

Формат ответа

Данные всегда возвращаются в формате JSON.

Общий формат ответа содержит следующие поля:

code: "code"
message: "message"
field: "field"
value: "value"

Заголовок ответа ETag

Заголовок ответа может содержать поле ETag, что позволяет клиенту выполнять условные запросы. Условный GET запрос обращается за документом учитывая дополнительные параметры для уменьшения нагрузки на сервер. См. w3 документацию.

Общие ошибки для всех методов API