Начало работы с API

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

Предусловия

Перед началом работы с API убедитесь, что выполнены следующие условия:

#1Регистрация партнёра

Партнёр (арендная компания) должен быть зарегистрирован в системе. Это делается силами техподдержки Жугори.

#2Регистрация пользователя

Пользователь должен быть зарегистрирован в системе и привязан к партнёру с нужной ролью. Также выполняется техподдержкой.

#3Регистрация автомобиля

Должен быть зарегистрирован хотя бы один автомобиль. Желательно с фотографиями в нескольких ракурсах.

#4Фотографии автомобиля

Рекомендуется загрузить фотографии автомобиля — это повышает привлекательность для пользователей.

Регистрация партнёра, пользователя и выдача токенов выполняется силами техподдержки. Свяжитесь с нами через страницу контактов.

Аутентификация

Все запросы к API должны быть подписаны Bearer JWT-токеном, выданным от имени пользователя партнёра.

Заголовок авторизации

Передавайте токен в заголовке Authorization каждого запроса:

HTTP Header

Authorization: Bearer <your-jwt-token>

Срок жизни токена

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

Минимальный пример запроса

cURL

curl -X GET https://api.zhugory.ru/api/car   -H "Authorization: Bearer <your-jwt-token>"   -H "Content-Type: application/json"

Вебхуки и уведомления

Бизнес-процесс начинается с того, что пользователь оставляет заявку. Жугори уведомляет партнёра двумя способами — на выбор:

Вебхук (POST)

Жугори отправляет POST-запрос с телом в JSON на URL, указанный партнёром. Подходит для автоматической обработки в CRM или ИИ-агенте.

Email-уведомление

Письмо отправляется на адрес, указанный партнёром. Подходит, если автоматическая интеграция не нужна — заявку можно обработать вручную в приложении.

Как это работает

Пользователь оставляет заявку на аренду автомобиля в приложении Жугори.

Жугори отправляет уведомление партнёру — POST-запросом на URL или письмом на email.

Партнёр обрабатывает заявку — через API или в мобильном приложении: принимает, подтверждает или отклоняет.

Формат вебхука

При наступлении события (например, новая заявка) Жугори отправляет POST-запрос с телом в JSON на URL партнёра.

POST https://your-server.com/webhooks/zhugory

POST /webhooks/zhugory HTTP/1.1
Host: your-server.com
Content-Type: application/json

{
  "тело запроса ..."
}

Тело запроса и список параметров настраиваются с каждым партнёром индивидуально в соответствии с его требованиями — при подключении вы согласовываете с техподдержкой структуру данных и формат доставки.

URL вебхука или email для уведомлений настраивается техподдержкой при подключении партнёра — вместе с телом запроса и списком параметров, которые согласовываются индивидуально с каждым партнёром. Полный список событий доступен в справочнике методов.

Базовый URL и форматы

Базовый URL

https://api.zhugory.ru

Формат данных

JSON для всех запросов и ответов

Кодировка

UTF-8

Транспорт

HTTPS — все запросы только по защищённому соединению

Коды ошибок

API использует стандартные HTTP-коды состояния. Полный список кодов ошибок будет добавлен позднее.

Готовы к первому запросу?

Изучите справочник методов — все доступные эндпоинты с параметрами и примерами.

Справочник методов Назад к разделу API