Sur cette page:

Campus Events API

L'API Campus Events permet aux développeurs d'intégrer directement les données et les fonctionnalités de Campus Events dans leurs propres applications ou sites web. Il est ainsi possible, par exemple, d'intégrer facilement les détails d'un événement ou les listes de participants.

Notre API repose sur la technologie REST.

Les avantages de REST sont notamment les suivants :

  • Haute performance : traitement rapide des requêtes.
  • Évolutivité : bien adaptée au traitement simultané d'un grand nombre de requêtes.
  • Interfaces simples : faciles à comprendre et à mettre en œuvre.

La documentation est disponible à l'adresse https://IHREDOMAIN.com/api. Sous Système > Messenger > Webhooks, il est possible d'enregistrer des systèmes externes. Lors d'événements définis, un message correspondant leur est alors envoyé sous forme de « requête POST ».

Qu'est-ce que REST ? ​

REST est un standard très répandu pour l'échange de données via Internet. Il est basé sur les principes de HTTP (comme pour les pages web). Un client (p. ex. votre application) envoie une requête au serveur (p. ex. Campus Events) et le serveur renvoie une réponse avec les données souhaitées.

Comment obtenir une clé API ? ​

Une clé API permet d'accéder à l'API. Pour obtenir une telle clé, vous devez :

  1. Etre connecté à Campus Events.
  2. Etre affecté au groupe d'utilisateurs "API Key Hero" (qui a l'autorisation de créer et de gérer les clés API).

Vous trouverez les clés API sous : Configuration > Clés API. Vous pouvez y créer une nouvelle clé ou gérer les enregistrements existants en cliquant sur le bouton "+ Nouveau".

Groupes de données ​

Des groupes de données supplémentaires permettent de consulter des informations plus détaillées, parfois confidentielles, comme des données personnelles, des détails de facturation ou l'historique des commandes, qui ne sont normalement pas visibles.

Un aperçu actuel de tous les groupes de données :

  • données personnelles de l'utilisateur
  • données personnelles des participants
  • événements non publiés
  • données de facturation
  • données personnelles de la commande
  • informations sur la commande
  • informations de paiement supplémentaires

Points de terminaison API ​

Campus Events propose des fonctions API permettant de créer, modifier et supprimer des enregistrements. Les autorisations de création/modification et de suppression des enregistrements peuvent être configurées individuellement pour chaque clé API. Les fonctions suivantes sont disponibles

  • Événements (y compris les dates, les catégories de billets/prix, les images de l'événement ainsi que les informations et les téléchargements)
  • Listes d'événements
  • Lieux des événements
  • Catégories d’événements
  • Groupes cibles
  • Catégories de billets
  • Organisateurs
  • Catégories de filtres
  • Sponsors (avec téléchargement du logo)
  • Modérateurs
  • Personnes de contact
  • Création, modification et suppression des participants à l'événement (billets)
  • Création, modification et suppression des restrictions et des décisions relatives aux billets
  • Articles supplémentaires : les montants de TVA spécifiques à chaque article commandé y sont directement indiqués

Le point de terminaison API « /events/{id} » renvoie les données « dynamicAttributes » dans l'ordre de tri (conformément au tri effectué dans le backend). Tous les autres points de terminaison renvoient les « dynamicAttributes » (le cas échéant) par ordre alphabétique.

A noter

  • L'ordre des points de données n'est pas déterministe. Une modification à cet égard n'est ni exclue ni communiquée.
  • Les clients sont eux-mêmes tenus de consulter les Release Notes afin de détecter d'éventuelles modifications de l'API et, le cas échéant, d'en informer les autres prestataires de services.

Plate-forme API Campus Events ​

Vous pouvez accéder à la plateforme API viaIhre-Campus-Events-Domain.de/api. Ici, vous pouvez :

  • Voir les différents points finaux (interfaces) de l'API.
  • Explorer les structures de données.
  • Faire des demandes de test et consulter les résultats.

Pour cela, un utilisateur admin est nécessaire. Alternativement, la clé API peut être ajoutée à l'URL, par exemple :Ihre-Campus-Events-Domain.de/api(à cet endroit, "0" a été inscrit à titre d'exemple au lieu d'une clé API correcte.) Il faut tout de même passer par les autres étapes d'authentification.

En cliquant sur le bouton "Authorize", vous pouvez insérer votre clé API et définir l'autorisation pour les demandes (par ex. via l'en-tête ou l'URL).

Nous recommandons les méthodes via "apiKeyHeader (apiKey)".

Demandes API ​

Une fois que vous avez autorisé votre clé API, vous pouvez commencer à faire des demandes, par exemple pour récupérer des événements ou des données de participants. Cliquez sur "Try it out" pour générer une requête.

Par défaut, la réponse est donnée au format JSON, qui est facile à lire et à traiter par des programmes.

Exemple de demande (Curl) 

curl -X 'GET \
  'https://[votre domaine]/api/events?page=1' \
  -H 'accept : application/ld+json' \
  -H 'X-API-KEY : XXXXXXXX-XXXXXXXX-XXXXXX'

URL de la requête 

https:// [votre domaine] /api/events?page=1

Réponse 

{
  "@context" : "/api/contexts/Event",
  "@id" : "/api/events",
  "@type" : "hydra:Collection",
  "hydra:totalItems" : 409,
  "hydra:member" : [
    {
      "@id" : "/api/events/2946",
      "@type" : "Event",
      "orderType" : 4,
      "startDate": "2023-11-02T12:00:00+01:00",
      "endDate": "2023-11-03T16:30:00+01:00",
      "modifiedAt": "2023-11-03T16:30:07+01:00",
      "subtitle" : "Colloque au Centre international d'études/centre de langues",
      "name" : "Repenser l'internationalisation ?",
      "modifiedAtRecursive": "2024-07-10T00:08:52+02:00",
      "@urls" : {
        "directRegistrationUrl" : null,
        "eventUrl" : "https://[votre domaine]/event/internationalisation" 
      }
    }
  ]
}

Options de filtrage ​

Vous trouverez toutes les options de filtrage actuelles dans l'aperçu de l'API https://Votre domaine Campus-Events.de/api