Verbind jouw systeem met Ritify

Beheer voertuigen via één veilige API

Dit endpoint ondersteunt POST, PUT en DELETE. Je authenticeert via queryparameters en werkt met JSON in de body. Aanmaken van een voertuig retourneert het interne Ritify-id.

POST PUT DELETE

Authenticatie & toegang

Queryparameters

Parameter Verplicht Beschrijving id Ja Dealer-id (extern meegegeven) api Ja API-sleutel, gevalideerd samen met id

Headers

Header Waarde Content-Type application/json

Bij mislukte authenticatie volgt 401 Unauthorized

Base URL

POSThttps://external-vehicle-a72gyrudqa-ez.a.run.app?id=<DEALER_ID>&api=<API_KEY>

PUThttps://external-vehicle-a72gyrudqa-ez.a.run.app?id=<DEALER_ID>&api=<API_KEY>

DELETEhttps://external-vehicle-a72gyrudqa-ez.a.run.app?id=<DEALER_ID>&api=<API_KEY>

Vervang <DEALER_ID> en <API_KEY> door jouw waarden.

POSTVoertuig aanmaken

Alle velden zijn verplicht, behalve image en type. Stuur je wel een image mee, dan zijn image.url en image.filename verplicht.

Body · JSON

{
  "id": "ID",                  // dealer voertuig-id, string
  "make": "Merk",              // string
  "model": "Model",            // string
  "year": YYYY,                // number
  "color": "KLEUR",            // string
  "licensePlate": "AA-123-BB", // string
  "type": "car",               // optioneel: car, van of motorcycle
  "image": {
    "url": "https://example.com/test-123.jpg", // publiek toegankelijke URL
    "filename": "test-123.jpg"                 // bestandsnaam met extensie
  }
}

Voertuigtype

Het type bepaalt welke schadekaart Ritify gebruikt bij het vastleggen van schade bij ophalen en inleveren.

Waarde Omschrijving car Personenauto (standaard) van Bestelbus / bedrijfswagen motorcycle Motor, scooter of bromfiets

Validatie

Alle velden zijn verplicht, behalve image en type. Zonder type wordt car gebruikt. licensePlate wordt intern naar hoofdletters omgezet. id moet uniek zijn per dealer, anders volgt 400 Vehicle already exists

Response · 200

{
  "id": "RITIFY-ID",  // interne Ritify-id
  "message": "Vehicle successfully created",
  "url": "https://app.ritify.nl/testdrives/create?vehicle=RITIFY-ID"
}

PUTVoertuig bijwerken

Body · JSON

{
  "id": "ID",  // dealer voertuig-id, string
  "image": {
    "url": "https://example.com/test-123.jpg",
    "filename": "test-123.jpg"
  }
}

Response · 200

{
  "id": "RITIFY-ID",
  "message": "Vehicle successfully updated"
}

DELETEVoertuig verwijderen

Body · JSON

{
  "id": "ID"  // dealer voertuig-id, string
}

Response · 200

{
  "id": "RITIFY-ID",
  "message": "Vehicle successfully deleted"
}

Notities & best practices

AfbeeldingenZorg dat image.url publiek leesbaar is. Het ophalen gebeurt server-side, CORS is dus niet nodig. ValidatieVoorkom lege strings en stuur types zoals verwacht, bijvoorbeeld year als getal. VerwijderenBestaan er proefritten voor het voertuig, dan volgt een soft delete. Anders een hard delete. Rate limitingBeperk het aantal aanroepen aan jouw kant waar passend. VeiligheidBewaar API-sleutels veilig en deel ze niet publiekelijk.