Документация API#
Данный раздел содержит информацию о спецификации OpenAPI. Инженерам и программистам следует ознакомиться с этими документами, чтобы узнать о функциях LUNA PLATFORM и их реализации.
Эти документы:
- содержат текущую версию 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 предоставляются в двух форматах: HTML и YML.
Документ в формате HTML предоставляет визуальное представление спецификации API и может быть неполным.
Документ в формате YML содержит актуальную спецификацию для сервиса API. Вы можете импортировать файл во внешнее приложение для создания запросов (например, Postman) или визуализировать с помощью специальных инструментов.
Следующая таблица содержит ссылки на спецификацию OpenAPI для сервиса API, представленную в формате HTML и YML.
| Имя документа | Описание | Ссылка на документ |
|---|---|---|
| Спецификация OpenAPI в формате HTML | Общие запросы к сервису API | APIReferenceManual |
| Спецификация OpenAPI в формате YML | Общие запросы к сервису API | APIReferenceManual |