import { Button } from "zudoku/ui/Button";
import { FileDown } from "zudoku/icons";

# Partner API (v1.0)
> Documentation describes the possibilities of connecting to the platform **Vignette ID** for the possibility of processing vignettes, tunnels, and related road services.  
Endpoints cover products, users, and orders. Authentication is handled via API key or bearer token.  

<Button size="default">
  <FileDown  /> <a href="/documents/llms.txt" download="/documents/llms.txt"> Download llms.txt </a>
</Button>

Base URL: https://api.vignette.id

## Partnership
- [Partner Form](https://e-vignettes.eu/partner): Fill form to get access to sandbox and test Vignette ID API

## API Endpoints

- POST /mcp (https://api.vignette.id/mcp)
  Tags: Internal List Endpoints
  Description: MCP Server endpoint. Used by partners to create orders in Vignette ID system.

- GET /public/orders (https://api.vignette.id/public/orders)
  Tags: Orders List Endpoints
  Description: This endpoint allows you to obtain a list of all partner orders with all the necessary information about the order

- POST /public/orders (https://api.vignette.id/public/orders)
  Tags: Orders List Endpoints
  Description: New order on partner side initiate request for processing in Vignette ID system.

- [`GET /public/orders/{id}`](https://api.vignette.id/public/orders/{id})
  Tags: Orders List Endpoints
  Description: • `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

- [`POST /public/orders/{id}/cancel-deferred`] (https://api.vignette.id/public/orders/{id}/cancel-deferred)
  Tags: Orders List Endpoints
  Description: The ability to cancel an order that has a `DEFERRED` status if it is not processed within the specified time period

 • `DEFERRED` - only

- [`POST /public/orders/{id}/cancel-pending`] (https://api.vignette.id/public/orders/{id}/cancel-pending)
  Tags: Orders List Endpoints
  Description: The ability to cancel an order that has a `PENDING` status if it is not processed within the specified time period

 • `PENDING` - only

- [`GET /public/orders/{id}/status`] (https://api.vignette.id/public/orders/{id}/status)
  Tags: Orders List Endpoints
  Description: Returns only the order status.
 Applicable in cases where you need to check only the status without other information.

- GET /public/products (https://api.vignette.id/public/products)
  Tags: Products List Endpoints
  Description: All available products (vignettes, tunnels, bridges, trains, ferries) for customers in 9 European countries

- GET /public/products/status (https://api.vignette.id/public/products/status)
  Tags: Products List Endpoints
  Description: Returns the status of national providers, as well as all products.

- GET /public/users (https://api.vignette.id/public/users)
  Tags: Users List Endpoints
  Description: Returns an array of partner users who made at least 1 payment.

- [`GET /public/users/{id}/orders`] (https://api.vignette.id/public/users/{id}/orders)
  Tags: Users List Endpoints
  Description: An array of all vignettes for a specific user.

- POST /public/validate-vehicle (https://api.vignette.id/public/validate-vehicle)
  Tags: Extended List Endpoints
  Description: Possibility to check the vehicle number according to the selected country. 


## Bot Access Policy

Vignette ID preferences for AI/LLM access, training, and content usage:

- **User-agent: gptbot**  
  Allow‑Training: yes  
  Allow‑Retrieval: yes  

- **User-agent: claudebot**  
  Allow‑Training: yes  
  Allow‑Retrieval: yes  

- **User-agent: google-extended**  
  Allow‑Training: yes  
  Allow‑Retrieval: yes  

- **User-agent: perplexitybot**  
  Allow‑Training: yes  
  Allow‑Retrieval: yes  

- **User-agent: neevabot**  
  Allow‑Training: yes  
  Allow‑Retrieval: yes  

- **User-agent: youbot**  
  Allow‑Training: yes  
  Allow‑Retrieval: yes  

- **User-agent: ccbot** (Common Crawl)  
  Allow‑Training: yes  
  Allow‑Retrieval: yes  

- **User-agent: duckduckbot** (DuckDuckGo AI)  
  Allow‑Training: yes  
  Allow‑Retrieval: yes  

- **User-agent: yandexbot**  
  Allow‑Training: no  
  Allow‑Retrieval: no  

- **User-agent: archive.org_bot**  
  Allow‑Training: yes  
  Allow‑Retrieval: yes  

### Default Rule for Unspecified or Future Bots

- **User‑agent: \***  
  Allow‑Training: yes  
  Allow‑Retrieval: yes