Введение
Добро пожаловать в Vignetim Partner API (партнёрский API). Этот API позволяет интегрировать покупку виньеток (vignettes), пакетов данных eSIM и продуктов туристического страхования непосредственно в вашу платформу.
Базовый URL
Все запросы к API выполняются по адресу:
https://api.vignetim.com/v2/partners
API следует соглашениям RESTful и возвращает ответы в формате JSON. Все запросы должны быть аутентифицированы с использованием подписи HMAC-SHA256.
Возможности
- Продажа виньеток -- Просматривайте доступные виньетки для автомагистралей европейских стран и создавайте заказы от имени ваших клиентов.
- Продажа eSIM-пакетов -- Предлагайте пакеты мобильных данных для путешественников, охватывающие локальные, региональные и глобальные направления.
- Продажа туристического страхования -- Предоставляйте продукты туристического страхования с различными вариантами покрытия.
- Управление заказами -- Отслеживайте статус заказов, фильтруйте историю заказов и получайте уведомления через вебхуки (webhooks) в реальном времени.
Версионирование
Partner API версионируется через путь URL (/v2/). Несовместимые изменения будут вводиться только в новых мажорных версиях. Обратно совместимые дополнения (новые поля, новые эндпоинты) могут добавляться в текущую версию без предварительного уведомления.
Ресурсы для разработчиков
| Ресурс | Ссылка |
|---|---|
| Спецификация OpenAPI (JSON) | vignetim.com/api/partner-openapi |
| Swagger UI | api.vignetim.com/docs |
| Импорт в Postman | Скопируйте URL OpenAPI выше и используйте File > Import > Link в Postman |
| MCP-сервер | claude mcp add vignetim-api-docs --transport http https://vignetim.com/api/mcp |
Совет: Импортируйте спецификацию OpenAPI в Postman, Insomnia или любой другой API-клиент, чтобы получить готовые шаблоны запросов со всеми эндпоинтами и схемами.
Быстрый старт
- Получите учётные данные API -- Зарегистрируйте партнёрский аккаунт и получите API-ключ и секрет в панели управления.
- Используйте песочницу (sandbox) -- Начните в режиме песочницы для тестирования интеграции с имитацией платежей без реальных списаний.
- Аутентифицируйте запросы -- Подписывайте каждый запрос с помощью HMAC-SHA256 с необходимыми заголовками.
- Просматривайте продукты -- Получайте список доступных виньеток, eSIM-пакетов или страховых продуктов.
- Создайте заказ -- Отправьте заказ с выбором продукта, платёжными данными и информацией о клиенте.
- Настройте вебхуки -- Зарегистрируйте эндпоинты вебхуков для получения уведомлений в реальном времени об изменениях статуса заказа.