Sur cette page:

Campus Events API

L'API Campus Events permet aux développeurs d'intégrer les données et les fonctions de Campus Events directement dans leurs propres applications ou sites web. Par exemple, les détails des événements ou les listes de participants peuvent être facilement intégrés.

Notre API est basée sur la technologie REST.

Les avantages de REST sont entre autres :

  • Haute performance : traitement rapide des demandes.
  • Évolutivité : bien adapté au traitement simultané de nombreuses demandes.
  • Interfaces simples à utiliser : Facile à comprendre et à mettre en œuvre.

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

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 

[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