Aperçu de la référence de l'API
GraphQL est un langage de requête pour les API. Il vous permet de demander exactement les données dont vous avez besoin en un seul appel, au lieu de passer par de nombreux endpoints REST fixes.
L’API est construite sur GraphQL. Chaque ressource, comme les véhicules, les stations, les itinéraires et les sessions de navigation, est disponible via une seule API GraphQL. Vous pouvez accéder à chacune sous forme de query, de mutation ou de subscription.
Si vous découvrez GraphQL, la documentation officielle de GraphQL est un bon point de départ.
Endpoints GraphQL
Les queries, mutations et subscriptions sont disponibles aux endpoints ci-dessous. Consultez envoyer votre première requête pour un exemple.
Pour les queries et les mutations, utilisez :
Pour les subscriptions, utilisez :
Ressources
Parcourez l’API par ressource. Chaque section ci-dessous renvoie vers ses queries, mutations et subscriptions.
| Ressource | Description |
|---|---|
| Véhicule | Consultez les caractéristiques des VE, les modèles de consommation et les données de tarification premium. |
| Véhicule connecté | Connectez un véhicule à un fournisseur de connectivité et récupérez ses données en direct. |
| Station | Consultez des stations de recharge individuelles, les stations à proximité et les équipements. |
| Avis sur la station | Lisez, ajoutez et supprimez les avis des utilisateurs sur une station de recharge. |
| Tarif de station | Consultez le coût de la recharge dans une station. |
| Opérateur de station | Consultez les détails sur l’opérateur de points de charge d’une station. |
| Tuiles | Accédez aux données des stations sous forme de tuiles de carte vectorielles ou JSON pour les afficher sur une carte. |
| Itinéraire | Calculez un itinéraire VE avec arrêts de recharge, consommation d’énergie et durée de trajet. |
| Itinéraire camion | Calculez un itinéraire de camion électrique en tenant compte du poids et des dimensions du véhicule. |
| Navigation | Suivez la progression d’un véhicule le long d’un itinéraire et recevez des mises à jour en temps réel. |
| Émissions | Calculez les émissions évitées en empruntant un itinéraire. |
| Isoline | Visualisez la zone qu’un véhicule peut atteindre depuis un point, selon son état de charge. |
Authentification
Chaque requête est authentifiée avec les en-têtes x-client-id et x-app-id. Consultez autorisation pour savoir comment les obtenir et les envoyer.
Pagination
Les queries de liste utilisent soit les arguments size et page, soit, pour la pagination par curseur, les arguments first et after. Consultez pagination pour plus de détails.
Limitation de débit
Les requêtes sont soumises à une limitation de débit.
Cycle de vie
Chargetrip utilise une API GraphQL unique et évolutive plutôt que des versions numérotées. Consultez cycle de vie pour savoir comment nous gérons les changements incompatibles et compatibles.
Ce contenu vous a-t-il été utile ?