Вступ
Ласкаво просимо до Vignetim Partner API. Цей API дозволяє інтегрувати придбання віньєток, пакети даних eSIM та продукти туристичного страхування безпосередньо у вашу платформу.
Базова URL-адреса (Base URL)
Усі API-запити надсилаються на:
https://api.vignetim.com/v2/partners
API дотримується RESTful-конвенцій та повертає відповіді у форматі JSON. Усі запити повинні бути автентифіковані за допомогою підпису запитів HMAC-SHA256.
Що ви можете робити
- Продаж віньєток -- Переглядайте доступні автодорожні віньєтки в європейських країнах та створюйте замовлення від імені ваших клієнтів.
- Продаж eSIM-пакетів -- Пропонуйте пакети мобільних даних для мандрівників, що охоплюють локальні, регіональні та глобальні напрямки.
- Продаж туристичного страхування -- Надавайте продукти туристичного страхування з різноманітними варіантами покриття.
- Керування замовленнями -- Відстежуйте статус замовлень, фільтруйте історію замовлень та отримуйте сповіщення через webhook у реальному часі.
Версіонування (Versioning)
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-пакети або страхові продукти.
- Створіть замовлення -- Надішліть замовлення з вибором продукту, платіжними даними та інформацією про клієнта.
- Налаштуйте webhook-и -- Зареєструйте ендпоінти webhook для отримання сповіщень у реальному часі про зміни статусу замовлень.