Aller au contenu principal

Démarrage rapide

astuce

Commencez immédiatement en effectuant votre première requête pour récupérer la liste des véhicules ici.

Prendre en main la Fleet API Cartrack est simple. Cette section propose un exemple basique pour effectuer votre première requête. L'exemple utilise curl, mais les mêmes principes s'appliquent en Python, JavaScript ou avec n'importe quel client HTTP.

Prérequis​

Avant de commencer, assurez‑vous de disposer de :

  • cURL installé : cURL est généralement disponible sur Unix, Linux et macOS, et peut être installé sous Windows.
  • URL de base et identifiants d'authentification : vous aurez besoin de l'URL de base de la Fleet API et d'identifiants valides. Consultez les sections Authentication et Base URLs pour les détails.

Effectuer un appel API​

Voici comment récupérer la liste des véhicules avec curl :

curl --location '{baseUrl}/rest/vehicles' \
--header 'Accept: application/json' \
--header 'Authorization: Basic your_encoded_credentials'

Remplacez {baseUrl} par l'URL de base fournie et your_encoded_credentials par vos identifiants encodés en Base64.

Comprendre la commande​

  • --location : demande à curl de suivre les redirections éventuelles.
  • --header : permet d'ajouter des en‑têtes. Ici, on accepte du JSON et on fournit les identifiants d'authentification.
  • L'URL d'endpoint ({baseUrl}/rest/vehicles) définit la ressource utilisée pour récupérer la liste des véhicules.

Réponse​

L'API renvoie un JSON contenant la liste des véhicules, avec des informations telles que l'identifiant, le modèle et d'autres attributs pertinents.

Cet exemple constitue un cadre initial pour vos appels API. Adaptez‑le au langage ou à l'outil de votre choix. Pour en savoir plus sur les endpoints et les fonctionnalités, poursuivez la lecture de la documentation.

Importer dans Postman​

Vous pouvez importer la spécification OpenAPI Cartrack dans Postman pour générer une collection prête à l'emploi.

  • URL du spec : https://developer.cartrack.com/openapi/openapi.yaml
  • Dans Postman : Import → Link, collez l'URL puis cliquez sur Import, ou Import → File et importez le fichier openapi.yaml téléchargé.
  • Postman génère une collection de requêtes à partir du spec.
  • Configurez les variables d'environnement :
    • Définissez l'URL de base selon la page Base URLs.
    • Configurez l'authentification : les APIs Cartrack utilisent Basic Authentication. Dans Postman, sur l'onglet Authorization, sélectionnez Basic Auth et renseignez votre nom d'utilisateur et mot de passe. Vous pouvez aussi ajouter l'en‑tête Authorization avec la valeur Basic <base64-encoded-credentials>. Consultez la page Authentication pour la génération des identifiants.
  • Exécutez des requêtes uniques ou le Collection Runner pour lancer plusieurs appels.