Die API mithilfe von ReDoc ansehen
Zugriff auf die API für Endpunktdokumentation und -tests |
BarTender enthält die vollständige Dokumentation für die API-Endpunkte sowie Beispiele für Aktionen in den Formaten YAML, JSON und BTXML. Sie können diese Dokumentation nach der Installation von BarTender ansehen. Verwenden Sie dafür ReDoc, das in der BarTender-Installationsdatei enthalten ist.
Die API mithilfe von ReDoc ansehen
Bevor Sie eigene Anwendungen für die API entwickeln, sollten Sie ein Tool verwenden, um ihre Funktionsweise zu testen. Sie können verschiedene gängige Tools wie Insomnia und Postman verwenden, um auf die API-Endpunkte zuzugreifen.
Zugriff auf die API-Endpunkte mit Insomnia
Wenn Sie BarTender auf einem Computer mit Fernverbindung ausführen, beachten Sie die folgenden Richtlinien, wenn Sie auf die REST API zugreifen. Das gilt sowohl, wenn Sie die API ausführen, als auch wenn Sie die API-Dokumentation abrufen:
Sie müssen Microsoft Internet Information Services (IIS) konfigurieren und Print Portal auf dem Server installieren, auf dem die BarTender REST API ausgeführt wird.
Greifen Sie über „http://<hostname oder IP-Adresse>/BarTender/api/actions“ auf die API-Endpunkte zu.
Greifen Sie über „http://<hostname oder IP-Adresse>/BarTender/api/actions/reference/index.html“ auf die ReDoc-Dokumentation zu.
Der Browser fordert Sie möglicherweise auf, für die Authentifizierung Ihre Anmeldedaten einzugeben.
Falls Sie ein Domänenbenutzer sind und sich der Remote-Computer, den Sie ausführen, in derselben Windows-Domäne befindet, können Sie sich mit Ihrem Domänenkonto anmelden. Andernfalls benötigen Sie ein lokales Konto des Remote-Computers.
Beim Ausführen der REST API können die folgenden Fehler auftreten:
401: Zeigt an, dass der HTTP-Client sich nicht beim Computer anmelden konnte, der in der URL angegeben wurde.
403: Zeigt an, dass die Anmeldeanforderung von einem Benutzer stammt, der keine Berechtigung hat, Integrationen zu verwalten. Damit ein Benutzer Aktionen oder BTXML-Skripte auszuführen kann, muss für ihn in der Administration Console für die Berechtigung Integrationen verwalten die Option Zulassen eingestellt sein.