Campus Events API

Die Campus Events API ermöglicht es Entwicklern, Daten und Funktionen aus Campus Events direkt in ihre eigenen Anwendungen oder Websites einzubinden. So können beispielsweise Veranstaltungsdetails oder Teilnehmerlisten einfach integriert werden.

Unsere API basiert auf der REST-Technologie.

Vorteile von REST sind unter anderem:

• Hohe Leistung: Schnelle Verarbeitung von Anfragen.
• Skalierbarkeit: Gut geeignet, um viele Anfragen gleichzeitig zu verarbeiten.
• Einfache Schnittstellen: Leicht verständlich und umsetzbar.

Was ist REST?

REST ist ein weit verbreiteter Standard für den Datenaustausch über das Internet. Es basiert auf den Prinzipien von HTTP (wie bei Webseiten). Ein Client (z. B. Ihre Anwendung) sendet eine Anfrage an den Server (z. B. Campus Events), und der Server schickt eine Antwort mit den gewünschten Daten zurück.

Wie erhalten Sie einen API-Key?

Ein API-Schlüssel ermöglicht den Zugang zur API. Um einen solchen Schlüssel zu bekommen, müssen Sie:

1. In Campus Events eingeloggt sein.
2. Der Benutzergruppe "API Key Hero" zugeordnet sein (diese hat die Berechtigung, API-Schlüssel zu erstellen und zu verwalten).

Die API-Schlüssel finden Sie unter: Konfiguration > API-Keys. Dort können Sie über den Button "+ Neu" einen neuen Schlüssel anlegen oder bestehende Datensätze verwalten.

Der Schlüssel kann zusätzliche Datenzugriffsrechte (Zusätzliche Datengruppen) enthalten, z. B. um persönliche Teilnehmer- oder Bestelldaten abzufragen.

Datengruppen

Mit zusätzlichen Datengruppen lassen sich weiterführende, teils vertrauliche Informationen wie persönliche Daten, Rechnungsdetails oder Bestellverläufe abrufen, die normalerweise nicht sichtbar sind.

Eine aktuelle Übersicht aller Datengruppen:

• persönliche Benutzerangaben
• persönliche Teilnehmerangaben
• unveröffentlichte Veranstaltungen
• Rechnungsdaten
• persönliche Bestellerangaben
• Bestellinformationen
• zusätzliche Bezahlinformationen

Bitte beachten

• Die Reihenfolge der Datenpunkte ist nicht deterministisch. Eine Änderung hierzu wird weder ausgeschlossen noch kommuniziert.
• Kunden sind selbst in der Pflicht, die Release Notes auf mögliche Änderungen an der API zu sichten und dies ggf. anderen Dienstleistern mitzuteilen.

Die Campus Events API-Plattform

Über https://Ihre-Campus-Events-Domain.de/api können Sie die API-Plattform aufrufen. Hier können Sie:

• Verschiedene Endpunkte (Schnittstellen) der API ansehen.
• Datenstrukturen erkunden.
• Testanfragen stellen und Ergebnisse abrufen.

Hierfür ist ein Admin-Nutzer notwendig. Alternativ kann der API-key an die URL gehängt werden, z.B.: https://Ihre-Campus-Events-Domain.de/api?apiKey=00000000-0000000000000000-00000000 (an dieser Stelle wurde anstatt eines korrekten API-keys beispielhaft "0" eingetragen.). Die weiteren Authentifizierungsschritte sind trotzdem zu durchlaufen.

Durch Klick auf den Button "Authorize" können Sie Ihren API-Schlüssel einfügen und die Autorisierung für Anfragen festlegen (z. B. über Header oder URL). Wir empfehlen die Methoden über "apiKeyHeader (apiKey)".

Ihr erster API Request

Nachdem Sie Ihren API-Schlüssel autorisiert haben, können Sie mit Anfragen starten, z. B. um Veranstaltungen oder Teilnehmerdaten abzurufen. Klicken Sie auf "Try it out", um eine Anfrage zu generieren.

Die Antwort wird standardmäßig im JSON-Format ausgegeben, was leicht lesbar und gut mit Programmen verarbeitbar ist.

Beispielanfrage (Curl)

Curl

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

Request-URL

https://[Ihre Domain]/api/events?page=1

Response

{
  "@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": "Fachtagung am Internationalen Studienzentrum/Sprachenzentrum",
      "name": "Internationalisierung neu denken?",
      "modifiedAtRecursive": "2024-07-10T00:08:52+02:00",
      "@urls": {
        "directRegistrationUrl": null,
        "eventUrl": "https://[Ihre Domain]/event/internationalisierung" 
      }
    }
  ]
}

Die Antwort zeigt Ihnen dann die Veranstaltungsdetails an, wie Name, Datum und weitere Informationen.

Filteroptionen

Alle aktuellen Filteroptionen finden Sie in der Übersicht der API https://Ihre-Campus-Events-Domain.de/api