To use the API programmatically, you must first generate the ibaHD-API client code for the desired programming language.
You will need the following for this:
-
The interface definition file
ibaHD-API.proto.The proto file is delivered with the ibaHD-Server installation. You will find the file in the installation directory of ibaHD-Server under the following path:
C:\Program Files\iba\ibaHD-Server\ibaHD-API\ibaHD-API.proto
-
The gRPC tooling required to generate the ibaHD-API client.
For each supported language, there are detailed instructions on the gRPC website on how to generate the client code https://grpc.io/docs/tutorials/
Once you have generated the ibaHD-API client code, you can link it to the target application. Depending on the language used, it may be necessary to integrate additional gRPC and ProtoBuf basic packages into the application. Details on this can be found in the programming language-specific guides.
Note |
|
|---|---|
|
The gRPC toolchain for generating the client code is freely available as open source software and is not the intellectual property of iba AG. The tools are subject to change without prior notice. iba AG recommends creating a backup copy of the toolchain for code generation that was used to generate the client code for ibaHD-API. |
|