Vignette ID Partner API
Documentation describes the possibilities of connecting to the platform Vignette ID for the possibility of paying for the motorway in 9 European countries.
https://sandbox-api.vignette.idProducts List Endpoints
Endpoints for interacting with products.
Products (vignettes and tunnels)
All available products (vignettes, tunnels, trains, ferries) for customers in 8 European countries
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
country
Returns filtered products by country.
Supported countries at, ch, si, hu, sk , cz, ro, bg, md
type
Returns filtered products by type.
Supported types vignette, tunnel
currency
Return price of products in selected currency with the included individual commission for the partner.
Supported currencies EUR, UAH, USD, PLN, HUF and more
1
Products / Status
Returns the status of national providers, as well as all products.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
status
Returns filtered products by status.
Supported types online, offline
country
Returns filtered products by country.
Supported countries at, ch, si, hu, sk , cz, ro, bg, md
type
Returns filtered products by type.
Supported types vignette, tunnel
1
Users List Endpoints
Endpoints for interacting with Users.
Users
Returns an array of partner users who made at least 1 payment.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
page
1
User Orders
An array of all vignettes for a specific user.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
page
Path Parameters
id
ID of user
1
Orders List Endpoints
Endpoints for interacting with orders.
Get Orders
This endpoint allows you to obtain a list of all partner orders with all the necessary information about the order
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
status
Returns filtered orders by status.
ā¢ Statuses
Each vignette can have one of the statuses:
PENDING, WILL BE ACTIVE, ACTIVE, EXPIRED, REFUNDED, DELETED
bug_report
Use with all endpoints to inform us for bugs in API
1
Create order
New paid order on partner side initiate request for processing in Vignette ID system.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Request Body
Payload required to validate a vehicle plate.
terms_and_privacy_accepted
Must be true to indicate that terms and privacy are accepted. Partner need to store this information in the user order.
order_has_been_paid
ā¢ true - this means that the partner accepted and processed the payment on his side.
ā¢ false - to pay for an order, the API generates a link and returns it to the response in payment_link, which the partner must display to the user.
The payment is processed on our side.
The partner user email. Must contain the user's real email. By default, any emails from our side are disabled.
user
Object of User data.
cars
Array of Vehicles with vehicle plate and registration country.
products
Array of vignettes with custom id, name, period, and start date.
interchange_fee
1
{
"terms_and_privacy_accepted": true,
"order_has_been_paid": true,
"email": "[email protected]",
"user": {
"email": "[email protected]",
"user_name": "John Smith",
"passport_number": "FP123456"
},
"cars": [
{
"country": "ua",
"plate": "AA4544AA",
"vin_code": "VWT045FD9812VB341"
}
],
"products": [
{
"custom_id": "partnername-000001",
"name": "vignette-si-2a",
"start_date": 1690711200,
"period": 30
}
],
"interchange_fee": {
"amount": 0.33,
"currency": "EUR"
}
}Get Order
ā¢ id - order id in Vignette ID system
ā¢ custom_id - order id in Partner system
ā¢ provider_id - unique vignette id in national (government) providers systems
ā¢ cars -> provider_id - unique vignette identificator in national provider system
ā¢ cars -> pdf - confirmation file from national provider system
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
bug_report
Use with all endpoints to inform us for bugs in API
Path Parameters
id
id of order in Vignette ID system or custom_id from Partner system
1
Get Order Status
Returns only the order status. Applicable in cases where you need to check only the status without other information.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
bug_report
Use with all endpoints to inform us for bugs in API
Path Parameters
id
id of order in Vignette ID system or custom_id from Partner system
1
Cancel Pending Order (will be deprecated)
The ability to cancel an order that has a pending status if it is not processed within the specified time period
ā¢ PENDING - only
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
bug_report
Use with all endpoints to inform us for bugs in API
Path Parameters
id
id of order in Vignette ID system or custom_id from Partner system
1
Cancel Pending Order
The ability to cancel an order that has a PENDING status if it is not processed within the specified time period
ā¢ PENDING - only
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
bug_report
Use with all endpoints to inform us for bugs in API
Path Parameters
id
id of order in Vignette ID system or custom_id from Partner system
1
Cancel Future Order
The ability to cancel an order that has a FUTURE status if it is not processed within the specified time period
ā¢ FUTURE - only
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
bug_report
Use with all endpoints to inform us for bugs in API
Path Parameters
id
id of order in Vignette ID system or custom_id from Partner system
1
Extended List Endpoints
Extended endpoints.
Validate vehicles
Possibility to check the vehicle number according to the selected country.
A list of acceptable vehicle registration countries codes in two letter format like at, cz, pl, ua...
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
bug_report
Use with all endpoints to inform us for bugs in API
Request Body
Payload required to validate a vehicle plate.
cars
Array of vehicles with vehicle plate and registration country.
emails
Option to check user email
1
{
"cars": [
{
"country": "ua",
"plate": "AA4544AA",
"vin_code": "VWT045FD9812VB341"
}
],
"email": "[email protected]"
}