Coachview ist ein Online-Softwarepaket zur Kursverwaltung. Neben der Registrierung von beispielsweise Schulungen, Firmen und Personen und Anmeldungen in Coachview ist auch der Zugriff auf Daten von Coachview möglich. Dazu verwenden Sie APIs (Application Programming Interface), eine Sammlung von Anweisungen, die es Anwendungen und Geräten ermöglichen, miteinander zu kommunizieren. |
![]() |
Optionen: |
Coachview bietet zwei verfügbare Umgebungen, mit denen Sie Ihre APIs verbinden können. Die Produktionsumgebung (Live) und die Trainingsumgebung (Spielplatz). In der Trainingsumgebung können Sie Ihre APIs hinzufügen entwickeln und testen. Tests, die Sie hier ausführen, wirken sich nicht auf die Live-Daten aus. Aber Achtung! Die Trainingsumgebung wird periodisch mit Daten aus der Live-Umgebung überschrieben, es werden nicht alle Daten einzeln übernommen. Dies geschieht, wenn eine neue Version in dieser Umgebung installiert wird. Möchten Sie wissen, wann neue Versionen installiert werden? Klicken Sie hier für den Installationsplan. ;Möchten Sie wissen, welche Daten nicht enthalten sind? Klicken Sie hier für eine Übersicht. < /a> Die Live-Umgebung wird verwendet, um aktuelle Daten anzuzeigen aufheben oder aufschreiben. Nachdem die API-Links in der Trainingsumgebung erfolgreich getestet wurden, können Sie in Ihrer Live-Umgebung loslegen. Die APIs werden auf Basis einer 'Fair Use Policy' angeboten. Das bedeutet, dass Ihre Verwendung der APIs die Leistung für andere Clients nicht beeinträchtigen sollte. Es ist wichtig, sorgfältig darüber nachzudenken, welche APIs benötigt werden, um das gewünschte Ergebnis zu erzielen. Haben Sie Fragen dazu oder möchten Sie, dass wir mit Ihnen mitdenken? Dann kontaktieren Sie uns bitte. |
Dokumentation: |
Weil es Unterschiede zwischen der Trainingsumgebung und der Live-Umgebung geben kann, haben wir eine separate Dokumentation Seite. Neue APIs und Änderungen an bestehenden APIs werden zuerst in der Trainingsumgebung hinzugefügt. Neugierig geworden und wollen mehr wissen? Klicken Sie hier für die Dokumentationsseite. Sie verwenden Swagger. |
Autorisierung: |
Bevor Sie beginnen, ist es wichtig zu wissen, welche Berechtigungen Sie benötigen und wie Sie sicherstellen, dass Sie die APIs in den beiden testen verschiedene Umgebungen mit Swagger oder über Postman. |
Zum Testen der verschiedenen APIs über Swagger oder über Postman benötigen Sie ein Coachview-Benutzerkonto in der Trainingsumgebung und/oder der Live-Umgebung. Abhängig von den zu testenden APIs benötigen Sie Administratorrechte sowie Lese- und Schreibrechte auf verschiedenen Modulen. Welche Module notwendig sind, hängt von den APIs ab, die Sie verwenden möchten. Für die Live-Umgebung fällt für ein Benutzerkonto eine monatliche Lizenzgebühr an, abhängig von den eingerichteten Modulen. |
PublicId: |
Sie können eine Publicid verwenden, um Informationen aus Dateien abzurufen. Dies ist eine sichere und nicht nachvollziehbare Nummer. Wenn Sie immer noch unsere SOAP-Webdienste verwenden, sind Sie es gewohnt, interne IDs zu verwenden, was weniger sicher ist. Es empfiehlt sich daher auf unsere REST APIs umzusteigen. Mithilfe eines Übersetzungsdienstes können Sie die Übersetzung zwischen der internen ID und der PublicId vornehmen. |
Kosten: |
Für die Nutzung unserer APIs fallen monatliche Gebühren an. |
Fragen: |
Wenn Sie Fragen haben, wenden Sie sich bitte an unsere Support-Abteilung, senden Sie eine E-Mail an support@coachview.net. |
Hinweis: wird niemals möglich sein in der Live-Umgebung mit Swagger zu testen! Die Swagger-Seite der Trainingsumgebung kann sich von der Swagger-Seite der Live-Umgebung unterscheiden, da neue Ergänzungen zuerst im Training verfügbar werden. |