Yapla vous permet d'obtenir et éditer des données de plus en plus variées grâce à son API GraphQL
Pré-requis : Authentification
Pour utiliser l'API, il faut préalablement avoir obtenu un jeton d'accès (access token) via le protocole OAuth2. Cet article vous donne la procédure pour en avoir accès.
Utilisez ensuite l'endpoint de l'API, accessible selon votre région à l'URL suivante :
- Amérique du Nord :
https://s1.yapla.com/graphql - Europe :
https://s2.yapla.com/graphql
Introspection / Voir les champs racines
GraphQL est axé sur les schémas, ce qui permet de comprendre d'un coup d'œil l'ensemble des fonctionnalités d'une API.
Grâce à votre plateforme d'API (exemple : Postman, HTTPie, etc.), faites une introspection afin d'explorer le schéma du serveur et connaître les champs racines disponibles.
Le serveur vous indique alors la liste des champs racines dont vous allez pouvoir récupérer ou manipuler les données. Dans GraphQL, ce sont les points d’entrée de l’API.
Opérations possibles
Yapla met à disposition des champs pour deux types d'opérations :
- Query - Récupère des données du serveur. Une query spécifie les informations demandés pour le champ spécifié, et peut inclure des arguments pour préciser la récupération de données.
- Mutation - Manipule des données du serveur (création, édition, suppression). Une mutation spécifie les données à retourner après l'opération, et peut également inclure des arguments pour détailler celle-ci.
Note : Avec GraphQL, le serveur ne renvoie ou ne modifie que les données demandées dans la requête, ce qui évite de récupérer trop ou trop peu de données.
Pour plus d'informations sur l'utilisation de GraphQL, vous pouvez consulter la documentation de la spécification.
Champs publics et privés
Parmi les champs racines, tous n'ont pas le même niveau d'accès :
-
Champs publics : accessibles sans authentification ou autorisation particulière. Utilisés pour des données ou opérations qui ne présentent pas de risque de sécurité (ex. affichage d’informations générales).
-
Champs privés : protégés par un mécanisme d’authentification et/ou d’autorisation. Ils servent à manipuler ou consulter des données sensibles, ou à effectuer des actions réservées à certains rôles.