Dokumentation der SEMCO API
Als Alternative zu unseren fertigen Lösungen SEMCO® Kurskalender und SEMCO® Teilnehmer- und Firmenportale steht Ihnen auch unsere SEMCO® API zur Verfügung um Daten standardisiert auszulesen und beispielsweise völlig individuell auf Ihrer Webseite darzustellen.
Damit Sie und Ihre IT sich mit den Möglichkeiten unserer SEMCO® API vertraut machen können, wurde in diesem Dokument alles Wissenswerte zusammengefasst. Neben der technischen Dokumentation unserer RESTful-Schnittstelle finden Sie hier auch eine Beschreibung des standardmäßig angebotenen Tools Swagger UI. Dieses Tool bietet Ihnen eine interaktive Dokumentation der API gemäß der Open-API Spezifikation und ermöglicht es Ihnen unter anderem einen Request an die API abzuschicken und das Rückgabeergebnis anzuzeigen.
Dieser Artikel setzt Schnittstellen-Programmierkenntnisse voraus und ist vornehmlich für Ihre Webagentur oder Ihre IT-Abteilung gedacht.
Inhaltsverzeichnis
Ausgangspunkt
Grundlagen
- Service-URL
- Datenformat
- Authentifizierung
- Metadaten
- Paginierung
- Sortierung
- Filterung
- Status-Codes und Fehlermeldungen
- Caching
Swagger UI
- Zugriff auf Swagger UI
- Überblick
- Aufrufe der öffentlichen Ressourcen (API-Key Authentifizierung)
- Aufrufe der nicht öffentlichen Ressourcen (Authentifizierung mit SEMCO Benutzer)
Erstellen von Online-Buchungen
- Privatbuchung
- Firmenbuchung durch einen Teilnehmer
- Firmenbuchung durch einen Ansprechpartner mit zwei Teilnehmern