Bien démarrer

L’API publique couvre actuellement Rental. Votre logiciel peut synchroniser véhicules et dossiers de location, lancer des inspections et récupérer les résultats validés. La référence API définit précisément chaque requête et réponse.

1. Créer une clé

Un administrateur ouvre API & integrations dans l’application TrakarIA et crée une clé API. L’accès dépend de la formule Rental de l’organisation. Utilisez une clé par intégration : le secret complet n’apparaît qu’une fois. Comprendre l’authentification.

L’adresse de base est https://api.trakaria.com. Les requêtes effectuées avec votre clé modifient les vraies données de votre compte.

2. Vérifier l’accès et les limites

Placez votre clé dans votre terminal sans l’enregistrer dans le code source, puis effectuez une requête en lecture seule :

export TRAKARIA_API_KEY='your-api-key'
curl --fail-with-body --silent --show-error \
  -H "Authorization: Bearer ${TRAKARIA_API_KEY}" \
  https://api.trakaria.com/v1/capabilities

La réponse indique les fonctionnalités Rental et les limites applicables à votre organisation. Un 401 signale une clé invalide ou expirée ; un 403 peut signaler une permission ou une formule insuffisante. Comprendre les erreurs.

3. Synchroniser un véhicule et un dossier Rental

Pour un essai, utilisez des identifiants externes distincts et faciles à retrouver, sans données personnelles réelles. Les appels ci-dessous créent des dossiers dans votre compte. Remplacez les valeurs d’exemple ; réutilisez le même identifiant externe pour mettre à jour la même ressource. Conservez les id publics renvoyés pour les appels suivants.

curl --fail-with-body --silent --show-error \
  -X PUT 'https://api.trakaria.com/v1/vehicles/by-external/demo-vehicle-001' \
  -H "Authorization: Bearer ${TRAKARIA_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{"plate":"AA-123-AA","name":"Véhicule agence aéroport","photo_url":"https://cdn.example.com/fleet/demo-vehicle-001.jpg","make":"Example","model":"Car","trim":"Business","year":2025,"registration_date":"2025-03-20","vehicle_type":"hatchback","energy":"petrol","gearbox":"automatic","transmission":"fwd","color":"Bleu","mileage":12000,"source_revision":1}'

curl --fail-with-body --silent --show-error \
  -X PUT 'https://api.trakaria.com/v1/rentals/by-external/demo-reservation-001' \
  -H "Authorization: Bearer ${TRAKARIA_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{"vehicle_external_id":"demo-vehicle-001","source_revision":1}'

La seconde requête crée immédiatement une entrée visible dans le planning. Sa réponse contient l’id du dossier Rental et planning.entry_id. Seul vehicle_external_id est obligatoire dans le corps : dates prévues, références, lieux, contact et conducteurs sont facultatifs. Vous pouvez les envoyer à l’avance, au moment du handover physique ou plus tard. Sans heure de départ, TrakarIA utilise l’heure de création ; sans heure de retour, l’entrée planning reste ouverte.

Pour les modifications suivantes, augmentez strictement source_revision. Les champs absents gardent leur valeur actuelle et la même entrée planning est mise à jour, sans doublon. Consulter les règles de synchronisation.

Un upsert véhicule réussi rattache aussi le véhicule à l’organisation de la clé API : les utilisateurs autorisés de ce groupe peuvent alors le voir dans TrakarIA. Répéter un upsert inchangé réconcilie ce rattachement sans créer de doublon s’il manquait.

Après l’essai, retrouvez les dossiers dans TrakarIA et nettoyez-les avec les actions accessibles à votre groupe. L’API publique permet d’annuler un dossier Rental avant le départ via POST /v1/rentals/{rental_id}/cancel ; cette opération annule aussi son entrée planning. Elle n’expose pas de route générale DELETE pour les véhicules ou les dossiers Rental. Une annulation n’efface pas nécessairement leur historique.

4. Poursuivre l’inspection

Utilisez l’id public renvoyé par la seconde requête pour démarrer l’inspection de départ. Un utilisateur TrakarIA doit se connecter pour ouvrir le lien de lancement. Après validation, récupérez le rapport de départ ; après le retour, récupérez le rapport de comparaison. Vous pouvez aussi recevoir des webhooks signés et retrouver les événements manqués via GET /v1/events.