Les API, qu’elles soient publiques ou non, existent toutes pour la même raison.
Elles facilitent les nouveaux développements en s’appuyant sur une application existante.
Elles peuvent prendre différentes formes, du service web permettant d’accéder aux fonctionnalités d’un site à la bibliothèque logicielle qui permettra d’intégrer un logiciel dans un nouveau développement.
Les API ont toutes le même but : elles sont là pour offrir à des développeurs une interface vers les fonctionnalités d’un autre programme.
Plus besoin de connaître le programme qu’on souhaite exploiter sur le bout des doigts, connaître son API suffit.
Elles sont bien souvent accompagnées d’une documentation précise permettant un gain de temps très important.
Le site LearnyBox et les fonctionnalités proposées utilisent de nombreuses API dont Stripe ou Paypal par exemple, pour enregistrer et récupérer des données de transactions, utilisateurs, etc …
L'API Learnybox
L'API Learnybox est accessible depuis le menu de gauche dans Outils & pédagogie puis API
1 - La documentation
Toutes les fonctionnalités sont présentes dans l'api, avec le détail de ce qui est envoyé et ce que le client a comme données en retour.
Tous les univers et plugins sont disponibles dans le menu sur la gauche et une barre de recherche est également disponible :
Au milieu se trouve la description du type de réponse et à droite un exemple de réponse suite à la requête réalisée.
2 - L’authentification et la sécurité
Nous authentifions un client en 1er lieu grâce à son sous domaine LearnyBox, ensuite sa clé API reliée à son compte. Cette clé nous permet aussi d’autoriser l’accès aux ressources.
Vous pouvez créer autant de clés que vous voulez pour autoriser l’accès à des ressources bien particulières.
Un exemple si John ne doit avoir accès qu’aux données de formations, il utilisera une clé particulière.
Ensuite nous traçons tous les appels API pour suivre exactement ce qui se passe exactement dans notre système.
Comment tester l'API ?
Nous fournissons un accès pratique en langage PHP tout au début de la documentation, une librairie qui facilite le développement et les appels à notre API.
Celle-ci est disponible sur la packagist et tout le monde peut la télécharger :