Присоединяйтесь в пару кликов — бесплатный доступ к Dashboard навсегда.
Разработчикам
Введение
API LeeCyber позволяет вам управлять ресурсами в облаке программным способом с использованием обычных HTTP-запросов. Множество функций, которые доступны в Dashboard, также доступны через API, что позволяет вам автоматизировать ваши собственные сценарии. В этой документации сперва будет описан общий дизайн и принципы работы API, а после этого конкретные конечные точки. Также будут приведены примеры запросов к ним.
Запросы
Запросы должны выполняться по протоколуHTTPS, чтобы гарантировать шифрование транзакций. Поддерживаются следующие методы запроса:
Методы POST, PUT и PATCH могут включать объект в тело запроса с типом содержимого application/json.
| Метод | Примечание |
| GET | Извлекает данные о коллекциях и отдельных ресурсах. |
| POST | Для коллекций создает новый ресурс этого типа. Также используется для выполнения действий с конкретным ресурсом. |
| PUT | Обновляет существующий ресурс. |
| PATCH | Некоторые ресурсы поддерживают частичное обновление, то есть обновление только части атрибутов ресурса, в этом случае вместо метода PUT будет использован PATCH. |
| DELETE | Удаляет ресурс. |
Параметры в запросах
Некоторые коллекции поддерживают пагинацию, поиск или сортировку в запросах. В параметрах запроса требуется передать:
- limit — обозначает количество записей, которое необходимо вернуть
- offset — указывает на смещение, относительно начала списка
- search — позволяет указать набор символов для поиска
- sort — можно задать правило сортировки коллекции
Ответы
Запросы вернут один из следующих кодов состояния ответа HTTP:
| Статус | Описание |
| 200 OK | Действие с ресурсом было выполнено успешно. |
| 201 Created | Ресурс был успешно создан. При этом ресурс может быть как уже готовым к использованию, так и находиться в процессе запуска. |
| 204 No Content | Действие с ресурсом было выполнено успешно, и ответ не содержит дополнительной информации в теле. |
| 400 Bad Request | Был отправлен неверный запрос, например, в нем отсутствуют обязательные параметры и т. д. Тело ответа будет содержать дополнительную информацию об ошибке. |
| 401 Unauthorized | Ошибка аутентификации. |
| 402 Payment required | Доступ к запрашиваемому ресурсу ограничен до момента получения оплаты. |
| 403 Forbidden | Аутентификация прошла успешно, но недостаточно прав для выполнения действия. |
| 404 Not Found | Запрашиваемый ресурс не найден. |
| 409 Conflict | Запрос конфликтует с текущим состоянием. |
| 423 Locked | Ресурс из запроса заблокирован от применения к нему указанного метода. |
| 429 Too Many Requests | Был достигнут лимит по количеству запросов в единицу времени. |
Ограничение скорости запросов (Rate Limiting)
Чтобы обеспечить стабильность для всех пользователей, LeeCyber защищает API от всплесков входящего трафика, анализируя количество запросов c каждого аккаунта к каждой конечной точке
| Тип эндпоинта | Лимит запросов | Окно времени |
| Аутентификация | 5 запросов | 1 минута |
| Регистрация | 3 запроса | 1 минута |
| Сброс пароля | 3 запроса | 5 минут |
| Загрузка файлов | 10 запросов | 1 минута |
| Большие загрузки файлов | 5 запросов | 5 минут |
| AI запросы | 20 запросов | 1 минута |
| Облачные операции | 30 запросов | 1 минута |
| По умолчанию | 100 запросов | 1 минута |
Если ваше приложение отправляет более 100 запросов в минуту на одну конечную точку, то для этого запроса API может вернуть код состояния HTTP 429 Too Many Requests.
Аутентификация
Доступ к API осуществляется с помощью JWT-токена.
Токен необходимо передавать в заголовке каждого запроса в формате:
TEXTAuthorization: Bearer $LEECYBER_TOKEN
Чтобы использовать приведенные примеры, не подставляя каждый раз в них свой токен, вы можете добавить токен один раз в переменные окружения в вашей консоли. Например, на Linux это можно сделать с помощью команды:
TEXTLEECYBER_TOKEN="token"
После этого токен будет автоматически подставляться в ваши запросы.
Обратите внимание, что все значения в этой документации являются примерами. Не полагайтесь на идентификаторы операционных систем, тарифов и т.д., используемые в примерах. Используйте соответствующую конечную точку для получения значений перед созданием ресурсов.Версионирование
API построено согласно принципам семантического версионирования. Это значит, что мы гарантируем обратную совместимость всех изменений в пределах одной мажорной версии. Мажорная версия каждой конечной точки обозначается в пути запроса, например, запрос /v2/user указывает, что этот метод имеет версию 2.
Отправка запросов
Отправляйте запросы на api.leecyber.com, с указанием мажорной версии конечной точки запроса.
TEXTПример: https://api.leecyber.com/v2/user/auth
Валидация запросов
Все запросы к api.leecyber.com проходят строгую валидацию, если поля были заполнены некорректно, может вернуться следующая ошибка:
JSON{ "status": "Error", "msg": "Validation failed", "errors": [ "Field 'email' is required", "Field 'phone' has invalid format" ] }
Ответ с ошибкой
JSON{ "status": "Error", "msg": "Описание ошибки", "errors": ["Детали ошибки"] }
Успешный ответ
JSON{ "status": "OK", "data": { ... } }