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 en cliquant sur l'application LearnyConnect sur le bureau principal de votre compte:

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.

Nous l’avons rangé par univers et plugins, le menu sur la gauche:

Elle est constituée au milieu d’une description, du type de réponse et à droite d’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.

3 - Différences entre v1 et v2

Sécurité : nous avons ajouté un mécanisme de sécurité et d’authentification par jeton (token). Ce token sera utilisé dans toutes les requêtes à venir et toutes requêtes sans se voir refuser l’accès. Il est à durée limitée (30 min) et une fois expiré devra être renouvelé.

Alors pourquoi une durée de vie limitée ?

Imaginons qu’un terrible hacker mette la main sur votre token, il pourra avoir accès à vos données pour une durée limitée.

Nous avons ajouté les verbes : POST, GET, DELETE et PATCH. Plus explicites, ils

permettent de réaliser des actions bien définies.

POST pour la création, GET pour les listes, DELETE pour la suppression et PATCH pour la mise à jour.

Exemple : Formations dans la documentation.

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 :

https://packagist.org/packages/learnybox/learnybox-client-php

Avez-vous trouvé votre réponse?