Перейти к содержанию

Документация API#

Данный раздел содержит информацию о спецификации OpenAPI. Инженерам и программистам следует ознакомиться с этими документами, чтобы узнать о функциях LP и их реализации.

Эти документы:

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

Взаимодействие с сервисами LUNA PLATFORM обеспечивается за счет отправки HTTP-запросов.

Авторизация#

Почти все запросы, отправляемые в LP 5, требуют авторизации. В LUNA PLATFORM доступны следующие типы авторизации:

  • BasicAuth. Авторизация по логину и паролю (задаются при создании аккаунта).
  • BearerAuth. Авторизация с помощью токена JWT (выдается после создания токена).

Примечание. Также в рамках обратной совместимости с предыдущими версиями LUNA PLATFORM доступна авторизация LunaAccountIdAuth. Не рекомендуется использовать данную авторизацию в новых проектах, по умолчанию отключено.

Нет необходимости использовать все три типа авторизации при отправке запросов. Вы должны выбрать предпочтительный метод в зависимости от требуемых задач.

Для того чтобы воспользоваться одним из видов авторизации, у вас должен быть аккаунт. Аккаунт создается с помощью POST-запроса "create account" в сервис API, POST-запроса "register account" в сервис Admin или с помощью графического интерфейса Admin.

Если в запросе не указан тип авторизации, будет возвращена ошибка с кодом состояния 403.

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

Спецификации OpenAPI#

В настоящее время на русском языке доступна только спецификация OpenAPI для сервиса API. См. спецификации OpenAPI для других сервисов в английской версии документации.

Спецификация OpenAPI предоставляются в двух форматах: HTML и YML.

Документ в формате HTML предоставляет визуальное представление спецификации API и может быть неполным.

Документ в формате YML содержит актуальную спецификацию для сервиса API. Вы можете импортировать файл во внешнее приложение для создания запросов (например, Postman) или визуализировать с помощью специальных инструментов (например, https://editor.swagger.io/).

Следующая таблица содержит ссылки на спецификацию OpenAPI для сервиса API, представленную в формате HTML и YML.

Имя документа Описание Ссылка на документ
Спецификация OpenAPI в формате HTML Общие запросы к сервису API APIReferenceManual
Спецификация OpenAPI в формате YML Общие запросы к сервису API APIReferenceManual