Um die API programmatisch zu nutzen, müssen Sie zunächst den ibaHD-API-Client-Code für die gewünschte Programmiersprache generieren.
Hierfür benötigen Sie Folgendes:
-
Die Schnittstellendefinitionsdatei
ibaHD-API.proto.Die Proto-Datei wird mit der ibaHD-Server-Installation ausgeliefert. Sie finden die Datei im Installationsverzeichnis von ibaHD-Server unter folgendem Pfad:
C:\Program Files\iba\ibaHD-Server\ibaHD-API\ibaHD-API.proto
-
Das gRPC-Tooling, das für die Erstellung des ibaHD-API-Clients erforderlich ist.
Für jede unterstützte Sprache gibt es auf der gRPC-Website eine detaillierte Anleitung, wie Sie den Client-Code generieren können https://grpc.io/docs/tutorials/
Nachdem Sie den ibaHD-API-Client-Code generiert haben, können Sie ihn mit der Zielanwendung verknüpfen. Je nach verwendeter Sprache kann es erforderlich sein, zusätzliche gRPC- und ProtoBuf-Basispakete in die Anwendung einzubinden. Einzelheiten hierzu finden Sie in den programmiersprachenspezifischen Leitfäden.
Hinweis |
|
|---|---|
|
Die gRPC-Toolchain zur Generierung des Client-Codes ist als Open-Source-Software frei verfügbar und kein geistiges Eigentum der iba AG. Die Werkzeuge können ohne vorherige Ankündigung geändert werden. iba AG empfiehlt eine Sicherungskopie der Toolchain zur Code-Generierung zu erstellen, die zur Generierung des Client-Codes für ibaHD-API verwendet wurde. |
|