APIs et Webhooks pour l’intégration dans des systèmes externes
Nos API sont basées sur le protocole REST et utilisent JSON comme format de données. Une spécification Open API 3.0.2 est disponible pour toutes nos API et webhooks, ce qui permet à nos partenaires d’intégration de générer des modèles de code avec vérification de types et des wrappers API pour nos points de terminaison au sein de leurs outils.
La documentation des API et des webhooks est générée à partir de ces spécifications Open API et mise à la disposition de nos partenaires dans le cadre du programme développeur ioki. Ce programme offre également l’accès à un bug tracker partagé et est essentiel pour communiquer les changements d’API. La documentation comprend le API Guide, la Passenger API, la Driver API, la Platform API et les Webhooks.
API Guide
Le API Guide fournit des instructions détaillées pour une utilisation appropriée
Passenger API
Permet de développer des comptes clients passagers complets
Driver API
Fournit tous les éléments nécessaires à l’intégration d’un compte conducteur tiers
Platform API
Permet l’intégration de notre suite ioki Platform avec des backends externes
Webhooks
Transmettent des informations en temps réel à une application tierce
Le Programme Développeur
L’adhésion au programme développeur ioki est obligatoire pour intégrer nos API
La première étape consiste à signer un NDA (accord de non-divulgation) avec ioki. Selon votre relation avec ioki, votre gestionnaire de compte clé, votre contact commercial ou votre partenaire technique vous guidera à travers ce processus simple. Ce NDA est également nécessaire si vous effectuez une analyse de besoins ou une étude de faisabilité et que vous devez consulter la documentation avec votre équipe. Une fois le NDA signé, nous créerons des comptes pour vous et les membres de votre équipe afin d’accéder à notre instance GitLab développeur.
Avec ce compte, vous aurez accès à la documentation API la plus récente et au bug tracker. Nous sommes rigoureux dans ce processus car nos API ne sont pas publiques et nécessitent généralement des clarifications préalables en raison de leur complexité. De plus, bien que l’accès à la documentation et au suivi des bugs soit essentiel, le programme développeur offre bien plus, vous permettant de bénéficier de processus optimisés
Liste complète des avantages
- Accès à l’ensemble de notre documentation : API Guide, Passenger API, Driver API, Driver API et documentation des Webhooks
- Accès à un bug tracker partagé pour rester informé des questions, demandes et rapports de bugs
- Support technique : gestion de la communication avec vos équipes de développement
- Mise à disposition d’un environnement de test personnalisé selon le cas d’utilisation
- Session de lancement avec un développeur ioki pour discuter des détails techniques importants
- Accompagnement pendant la phase d’intégration : votre équipe de développement bénéficie d’un point vidéo hebdomadaire animé par un développeur senior. Nous avons constaté qu’un échange régulier accélère considérablement le processus de développement.
API Guide
Les API ioki partagent des principes de conception communs. Par exemple : quels en-têtes sont nécessaires, comment fonctionne la pagination, comment l’API expose les erreurs, et bien d’autres sujets. Certaines parties de cette documentation peuvent être pertinentes pour la plupart, mais pas nécessairement pour toutes les API, les points de terminaison et les cas d’utilisation. Assurez-vous de parcourir tous les sujets avant de commencer le développement.
Passenger API
Cet Passenger API permet le développement de comptes clients passagers, quel que soit leurs spécificités. Les clients les plus basiques peuvent utiliser une interface utilisateur simple, permettant à un utilisateur de demander un trajet de A à B, d’obtenir un résultat de base, puis de réserver ou d’annuler. Cependant, l’API offre bien plus de fonctionnalités pour ceux qui veulent exploiter tout son potentiel. Vous pouvez effectuer des réservations immédiates ou futures dans différentes zones géographiques, accéder à des informations sur le service, évaluer, payer, laisser un pourboire, voir la position du véhicule en approche, obtenir des détails sur les stations, des informations piétonnes, des mises à jour en direct et des recalculs de temps. Vous avez également accès à l’historique des trajets, aux trajets futurs, aux reçus, et bien plus encore. Toutes nos fonctionnalités peuvent être intégrées dans votre système.
Driver API
Cette Driver API met à disposition tous les éléments indispensables à l’intégration d’un compte conducteur tiers. Il peut s’agir d’une application simple listant les adresses et les heures pour les conducteurs, mais comme pour la Passenger API, vous pouvez aller plus loin : nous utilisons nos propres APIs et fournissons un client de référence avec un système de navigation étape par étape complet, une fonctionnalité de check-in / check-out des passagers, ainsi qu’une assistance aux conducteurs depuis leur départ du dépôt jusqu’à leur retour.
Platform API
Les Passenger et Driver API sont utilisées par des clients sur des appareils mobiles, tandis que la Platform API sert d’interface pour une intégration complète avec des backends externes. Nous visons une parité fonctionnelle avec notre produit standard, permettant un contrôle total des fonctionnalités via ces points d’extrémité. Vous pouvez créer, modifier ou supprimer diverses ressources, telles que de nouvelles stations, la reconfiguration de votre flotte, la mise en place de tournées, et la synchronisation des bases d’utilisateurs. Notre plateforme est conçue pour s’intégrer à tous types de flux de données et de cas d’utilisation, permettant ainsi la gestion de plusieurs produits avec différents clients et le partage de bases d’utilisateurs entre divers partenaires d’intégration. Pour des cas d’utilisation spécifiques, la Platform API permet même de délivrer des droits d’accès aux API Passenger et Driver API, afin que votre backend puisse agir au nom de passagers ou de conducteurs particuliers.
Webhooks
Les webhooks sont une méthode courante pour être informé des événements au sein d’un système. Nos webhooks vous permettent de rester informé des changements d’état et facilitent des cas d’utilisation allant de la simple lecture de données à des scénarios plus complexes nécessitant le déclenchement de logique côté client, qui peut ensuite interagir avec d’autres API. Les webhooks peuvent être configurés manuellement ou via la Platform API. Ils peuvent être activés pour chaque événement ou restreints à des événements spécifiques, et sont sécurisés par une signature utilisant un code secret prépartagé. Les webhooks non distribués sont répétés à l’aide d’un algorithme de backoff exponentiel. La récupération des données manquées via la Platform API est également possible. Bien que le payload des webhooks ne contienne pas de structures de données imbriquées à l’infini (la Platform API pouvant être utilisée pour obtenir des données supplémentaires si nécessaire), il inclut une représentation sérialisée complète de l’objet associé à l’événement. Les données fournies sont généralement suffisantes pour la plupart des cas d’utilisation.
N’attendez pas pour vous faire conseiller par nos experts
