Arise Programming Interface (API)

L’API d’ARISE (Administrateurs du Réseau Informatique et des Services aux Étudiants) offre une grande souplesse et permet de définir précisément les données souhaitées. Elle est ouverte aux arisers mais également aux étudiants et associations.

Aperçu

Voici quelques liens rapides pour vous aider à vous familiariser avec l’API :

• Effectuer des appels avec GraphQL
• Authentification
• Explorateur GraphQL

À propos de GraphQL

Le langage de requête de données GraphQL est :

• Une spécification. La spécification détermine la validité du schéma sur le serveur API. Le schéma détermine la validité des requêtes du client.
• Fortement typé. Le schéma définit le système de types d’une API et toutes les relations entre les objets.
• Introspectif. Un client peut interroger le schéma pour obtenir des détails sur celui-ci.
• Hiérarchique. La structure d’un appel GraphQL reflète la structure des données JSON qu’il renvoie. Les champs imbriqués vous permettent de rechercher et de recevoir uniquement les données que vous spécifiez en un seul aller-retour.
• Une couche applicative. GraphQL n’est ni un modèle de stockage ni un langage de requête de base de données. Le graphe fait référence aux structures de graphe définies dans le schéma, où les nœuds définissent des objets et les arêtes définissent les relations entre les objets. L’API parcourt et renvoie les données de l’application en fonction des définitions du schéma, indépendamment de la manière dont les données sont stockées.

Pourquoi ARISE utilise GraphQL

ARISE a choisi GraphQL car cette technologie offre une flexibilité nettement supérieure pour nos utilisateurs et applications internes. La possibilité de définir précisément les données souhaitées (et uniquement celles-ci) constitue un avantage considérable par rapport aux endpoint API REST traditionnels. GraphQL permet de remplacer plusieurs requêtes REST par un seul appel pour récupérer les données spécifiées.

Pour en savoir plus sur les raisons qui ont poussé ARISE à miser sur GraphQL, consultez le README du projet.

Cas d’usage

• Modifier ses données personnelles [Work in Progress]
• Récupérer les informations d’un utilisateur via OAuth
• Obtenir une donnée en particulier sur l’ensemble des utilisateurs
  • Nécessite une autorisation préalable d’ARISE