| Tipps & Tricks

Dokumentation der SEMCO API

Als Alternative zu unseren fertigen Lösungen SEMCO® Kurska­lender und SEMCO® Teilnehmer- und Firmen­portale steht Ihnen auch unsere SEMCO® API zur Ver­fügung um Daten standar­disiert auszulesen und beispiels­weise völlig individuell auf Ihrer Webseite darzu­stellen.

Damit Sie und Ihre IT sich mit den Möglich­keiten unserer SEMCO® API vertraut machen können, wurde in diesem Dokument alles Wissenswerte zusammen­gefasst. Neben der technischen Dokumentation unserer RESTful-Schnitt­stelle finden Sie hier auch eine Beschrei­bung des standard­mäßig angebo­tenen Tools Swagger UI. Dieses Tool bietet Ihnen eine inter­aktive Dokumentation der API gemäß der Open-API Spezifi­kation und ermög­licht es Ihnen unter anderem einen Request an die API abzu­schicken und das Rückgabe­ergebnis anzu­zeigen.

Dieser Artikel setzt Schnitt­stellen-Program­mierkennt­nisse voraus und ist vornehm­lich für Ihre Webagentur oder Ihre IT-Abtei­lung gedacht.

 

Inhaltsverzeichnis

Ausgangspunkt

Grundlagen

  1. Service-URL
  2. Datenformat
  3. Authentifizierung
  4. Metadaten
  5. Paginierung
  6. Sortierung
  7. Filterung
  8. Status-Codes und Fehlermeldungen
  9. Caching

Swagger UI

  1. Zugriff auf Swagger UI
  2. Überblick
  3. Aufrufe der öffentlichen Ressourcen (API-Key Authentifizierung)
  4. Aufrufe der nicht öffentlichen Ressourcen (Authentifizierung mit SEMCO Benutzer)

Erstellen von Online-Buchungen

  1. Privatbuchung
  2. Firmenbuchung durch einen Teilnehmer
  3. Firmenbuchung durch einen Ansprechpartner mit zwei Teilnehmern

Anpassbarkeit

Zurück zur Übersicht

© 2021 SEMCO Software Engineering GmbH