APIs
As mentioned previously, the hzn
CLI makes use of underlying RESTful APIs that interact with all the components of the Management Hub and the Edge Agent. These extensive CLIs are built upon APIs and provide all that a user would ever need. However, if your project requires access to the APIs, then they are available under the following categories:
- Agent API
- Agbot API
- Agbot User API
- Exchange API
- MMS API
- FDO API
All of these APIs follow standard RESTful API conventions and provide extensive CRUD capabilities via POST, PUT, GET, PATCH, and DELETE functions, as applicable for the object that they manage.
All of the APIs use https
as the underlying protocol and require an identical set of user access credentials for the given organization, as specified by HZN_ORG_ID
, and an authentication parameter, as specified by HZN_EXCHANGE_USER_AUTH
.
A typical hzn
CLI command may make use of multiple API calls to complete a user request, as specified by...