Mira for developers
Build on Mira
- Three APIs and signed webhooks connect your own system to Mira: journeys for handovers and financed sales, vehicle stock for dealers, and the product catalogue for product sellers.
- One developer key per business opens every API your kind of account can use, with a separate sandbox key that never touches real data.
- Every API answers in the same JSON shape and is matched on your own ids, such as your deal number, stock code or product code.
APIs
Journeys API
/api/v1/journeys
Verified handovers, identity checks and financed sales
Start a customer's journey from your own dealer or broker system. Mira guides the customer through each step in the app and reports every step back to you.
Vehicle stock API
/api/v1/stock
Keep your Mira stock in step with your dealer management system
Add, update and take vehicles off sale using your own stock codes. When a car sells through Mira, your system hears about it by webhook.
Product catalogue API
/api/v1/products/catalogue
Send your parts and accessories catalogue from your own system
Add and update products by your own product code, keep stock current and remove products, one at a time or a hundred in one call.
Webhooks
Signed events for everything you started through the API
One endpoint for live events and one for test events, signed with HMAC-SHA256, retried for about two days, with a delivery log you can resend from.
What your account can use
One developer key per business. What it opens follows your kind of account, and new APIs for your kind of account work with your existing key.
| API | Dealer | Broker | Product seller |
|---|---|---|---|
| Journeys API | Yes | Yes | |
| Vehicle stock API | Yes | ||
| Product catalogue API | Yes | ||
| Webhooks | Yes | Yes |
Three journeys
Finance, identity check and handover
The full flow for a financed sale: the finance application, then the customer's identity check, then the verified handover.
Dealer or broker keys
Identity check and handover
For a financed sale already approved on your own panel. You send who to verify; Mira runs the identity check, tells you the result, then runs the handover.
Dealer or broker keys
Handover only
A verified handover with no finance application in Mira. Say whether it is a cash sale or a finance sale.
Dealer or broker keys (cash sales: dealer keys)
Built for integrators
One key, every API
A single developer key per business covers every API your account can use, with a separate sandbox key. Rotate or set an expiry whenever you like.
A real sandbox
Sandbox calls are checked exactly like live ones and never touch real customers, stock or money. Journeys can be forced to any outcome.
Signed webhooks
HMAC-SHA256 signatures, retries for about two days, and a delivery log you can resend from.
Your own ids
Vehicles and products are matched on your stock code and product code, so syncing is a simple, repeatable call.
Your first call
Every API lives under https://api.motorsync.co.uk and takes your developer key as a bearer token. Pick the API your account uses. With a sandbox key (ms_test_) the call is checked exactly like a live one and nothing real happens.
Dealers and brokers. Starts a simulated identity check and handover for a sale already approved on your finance panel.
curl -X POST https://api.motorsync.co.uk/api/v1/journeys \
-H "Authorization: Bearer ms_test_..." \
-H "Idempotency-Key: deal-88213" \
-H "Content-Type: application/json" \
-d '{
"type": "IDENTITY_DELIVERY",
"externalReference": "DMS-88213",
"customer": {
"firstName": "Jane", "lastName": "Doe",
"email": "jane@example.com", "mobile": "07700900000"
},
"vehicle": { "registration": "AB21XYZ", "make": "BMW", "model": "3 Series", "year": 2021 },
"delivery": { "type": "HOME_DELIVERY" },
"finance": { "panelName": "iVendi", "panelReference": "IV-123456", "lender": "Close Brothers" }
}'