Renta REST API
Renta REST API позволяет управлять тремя основными ресурсами ELT: Источниками (Source), Направлениями (Destination) и Пайплайнами (Pipeline).
Renta REST API поддерживает операции CRUD, которые позволяют полностью управлять всеми ресурсами через API.
Ниже приведена таблица доступных ресурсов и поддерживаемых операций:
| Ресурс | Поддерживаемые операции |
|---|---|
| Source | Создание, просмотр, обновление, удаление |
| Destination | Создание, просмотр, обновление, удаление |
| Pipeline | Создание, просмотр, обновление, удаление, запуск |
Эндпоинт API
Renta REST API доступен по следующему базовому URL.
| Регион | Базовый URL (эндпоинт) |
|---|---|
| Europe | https://api.eu.renta.im |
Коллекция Postman
Для упрощения изучения и интеграции API мы предоставляем готовую к использованию коллекцию Postman. Она включает предварительно настроенные запросы для всех доступных эндпоинтов и настройку аутентификации.
Мы настоятельно рекомендуем использовать коллекцию Postman для упрощения процесса внедрения, тестирования и ускорения вашего знакомства с Renta API.
HTTP коды статуса
API использует стандартные коды статуса HTTP для индикации успеха или неудачи запроса.
| Код | Описание |
|---|---|
| 200 | OK. Запрос прошел успешно, сервер вернул ожидаемый ответ. |
| 400 | Bad Request. Запрос недействителен из-за некорректного JSON, отсутствующих или неверных параметров. |
| 401 | Unauthorized. Ошибка аутентификации, обычно из-за отсутствующего или недействительного токена. |
| 403 | Forbidden. У аутентифицированного пользователя нет необходимых прав для доступа к запрошенному ресурсу. |
| 500 | Internal Server Error. На сервере произошла непредвиденная ошибка. Пожалуйста, свяжитесь с поддержкой, если проблема повторится. |
Лимиты запросов (Rate Limiting)
Для API установлены лимиты частоты запросов. Использование можно отслеживать через заголовки ответа, такие как X-RateLimit-Limit, X-RateLimit-Remaining и X-RateLimit-Reset.
С чего начать работу с Renta API
Быстрый старт: ваш первый вызов API
Перейдите в панель управления Renta и сгенерируйте API токен. Храните этот токен в безопасности, так как он предоставляет полный доступ к вашей учетной записи.
Загрузите нашу коллекцию Postman и импортируйте ее в рабочее пространство Postman для удобного тестирования.