Introduction
Welcome to the Vignetim Partner API. This API enables you to integrate vignette purchases, eSIM data packages, and travel insurance products directly into your platform.
Base URL
All API requests are made to:
https://api.vignetim.com/v2/partnersThe API follows RESTful conventions and returns JSON responses. Every request is authenticated with your API key; mutating endpoints (order creation and webhook management) are additionally protected with HMAC-SHA256 request signing. See Authentication.
What You Can Do
- Sell Vignettes -- Browse available highway vignette tickets across European countries and create orders on behalf of your customers.
- Sell eSIM Packages -- Offer mobile data packages for travelers.
- Sell Insurance -- Provide insurance products such as Green Card motor insurance.
- Pay with Saved Cards or Wallet -- Charge cards vaulted through the partner dashboard, or draw from a prepaid EUR organization wallet funded by bank transfer.
- Manage Orders -- Track order status, filter order history, and receive real-time webhook notifications.
- Geo Checkpoints -- Fetch toll gates and control points with linked vignette products for route-based selling.
Partner Pricing
All product prices returned by the catalog endpoints (tickets, eSIM) are your partner-specific effective prices: the base catalog price adjusted by the margin configuration Vignetim maintains for your organization. Responses mark this with metadata.pricing: "effective". Different partners may see different prices for the same product; always display and charge the prices the API returns rather than caching prices across organizations.
Product availability can also vary per partner: a product family or specific countries may not be enabled for your organization. Unavailable products or countries are omitted from listings, and ordering them returns a 403 with the code PRODUCT_NOT_AVAILABLE or COUNTRY_NOT_AVAILABLE. See Error Handling for details.
Versioning
The Partner API is versioned via the URL path (/v2/). Breaking changes will only be introduced in new major versions. Non-breaking additions (new fields, new endpoints) may be added to the current version without notice.
Developer Resources
| Resource | Link |
|---|---|
| Swagger UI | api.vignetim.com/api/partner-docs |
| OpenAPI Spec (JSON) | api.vignetim.com/api/partner-docs-json |
| OpenAPI Spec (mirror) | vignetim.com/api/partner-openapi |
| Import to Postman | Copy an OpenAPI URL above and use File > Import > Link in Postman |
| MCP Server | claude mcp add vignetim-api-docs --transport http https://vignetim.com/api/mcp |
Tip: Import the OpenAPI spec into Postman, Insomnia, or any API client to get pre-built request templates with all endpoints and schemas ready to go.
Quick Start
- Get your API credentials -- Sign up for a partner account and retrieve your API key and secret from the dashboard.
- Use the sandbox -- Start with a
vgn_test_key to test your integration with simulated payments and no real charges. - Authenticate requests -- Send your API key on every request; sign order and webhook mutations with HMAC-SHA256.
- Browse products -- Fetch available vignettes, eSIM packages, or insurance products at your effective prices.
- Set up payment -- Vault a card in the partner dashboard or fund your wallet by bank transfer.
- Create an order -- Submit an order with product selection, payment method, and customer information.
- Set up webhooks -- Register webhook endpoints to receive real-time notifications about order status changes.