API GraphQL Oniva

Qu'est-ce que l'API GraphQL ?

L'API GraphQL d'Oniva permet un accès programmatique aux données d'événements – sans passer par l'interface utilisateur. Elle est basée sur GraphQL, un langage de requête flexible qui permet de définir précisément quelles données sont nécessaires.

L'API GraphQL est particulièrement adaptée aux intégrations plus complexes, où une plus grande flexibilité dans l'interrogation des données est requise. Pour des intégrations plus simples côté client, nous recommandons la REST API – elle est plus ciblée dans sa structure et donc plus rapide à prendre en main.

💡 Conseil : Tu ne sais pas quelle API choisir ? Le tableau comparatif en fin d'article t'aidera à prendre ta décision.

‍

Que peut-on faire avec l'API GraphQL ?

Les cas d'utilisation typiques de l'API GraphQL sont :

Import d'événements : Récupérer les détails d'événements pour afficher les événements à venir sur d'autres plateformes.

Accès aux participant·e·s : Récupérer la liste des invité·e·s et les statuts de check-in – p. ex. pour la gestion des événements sur place.

Intégrations personnalisées : Développer des solutions sur mesure pour des besoins spécifiques qui vont au-delà des fonctionnalités standard.

‍

Accéder à l'API GraphQL

URL de l'endpoint

L'URL de base pour accéder à l'API est :

/api/graphql

Authentification

Une clé app token est nécessaire pour accéder à l'API :

• La clé app token peut être fournie par le support Oniva ou créée via l'interface d'administration
• Un app token s'applique toujours à tous les événements d'un espace de travail
• Des event tokens et d'autres méthodes d'authentification sont disponibles pour les intégrations spécifiques à un utilisateur·trice

‍

Fonctionnement

Les requêtes GraphQL se divisent en deux types :

Queries : Récupération de données – p. ex. les détails d'un événement ou les informations sur les participant·e·s.

Mutations : Modification ou création de données – p. ex. la génération de tokens d'authentification.

Tu découvres GraphQL ? Apprendre GraphQL est une bonne introduction.

‍

Outils recommandés

Les outils suivants sont bien adaptés pour explorer et tester l'API :

GraphQL IDEsDes outils comme GraphiQL Online permettent d'explorer facilement l'API directement dans ton navigateur.

Clients HTTPLes requêtes peuvent également être envoyées avec des outils comme cURL ou Postman.

Accéder à la documentation API

La documentation technique complète – avec des guides, des exemples et des explications pour les développeur·trice·s – se trouve dans le dépôt de documentation de l'API GraphQL d'Oniva sur GitHub :

Documentation de l'API GraphQL d'Oniva