Start here

Getting started

Connect your own system to Mira in four steps. Everything runs in a sandbox first, so nothing reaches a real customer until you switch keys.
In short
  • Get a sandbox key in Mira Business, make your first call, add a webhook endpoint, then switch to a live key.
  • Nothing reaches a real customer, stock list or catalogue until you use a live key.

How it works

Every Mira business account has one developer key for all its integrations, plus a separate sandbox key. What a key can do depends on your kind of account: dealers get journeys and vehicle stock, brokers get journeys, and product sellers get the product catalogue. All calls go to https://api.motorsync.co.uk with the key as a bearer token, and answer in the same JSON envelope.

1. Get a sandbox key

  1. Sign in to Mira Business as the company owner.
  2. Open Settings, API Keys, switch to Test and generate a key. It starts with ms_test_.
  3. Copy it now: it is shown once. Keep it on your server, never in an app or web page.

2. Make your first call

Pick the API your account uses. A sandbox call is checked exactly like a live one, but changes nothing real.

Journeys
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" }
  }'

A success: false answer carries a code in errors[0].code and a message that says what to fix. See errors.

3. Listen for events

Add a test endpoint under Settings, Webhooks and Mira sends signed events as journeys move on, or when a car you sent through the stock API sells. Check the signature on every request; the webhooks guide has ready-made code.

4. Go live

When your integration works in the sandbox, generate a live key (ms_live_) and, for webhooks, a live endpoint. Change nothing else: the same calls and events work with real data.

Your APIs