Interacting as a User
Data Orchestrator is mainly accessed through its APIs. Data Orchestrator's APIs are exposed through dedicated microservices (see Components) and are meant both for configuration and for accessing data. There are two main sets of APIs we'll be using frequently:
- AppEngine API: This API is meant for querying/pushing data from/to devices. This maps to
astartectl'sastartectl appenginesubcommand. - Realm Management API: This API is meant for configuring a target realm, and most notably for managing triggers. This maps to
astartectl'sastartectl realm-managementsubcommand.
Authentication
Authenticating against Data Orchestrator is out of the scope of this guide, especially due to the fact that Data Orchestrator does not manage authentication directly. We'll assume either the authentication isn't enabled, or that the user is always interacting with the APIs with a token with the following claims
{
"a_aea": ".*:.*",
"a_rma": ".*:.*"
}
Which represents a realm administrator. In real life use cases, you should always make sure to give out more granular permissions and to obtain the token in the right way from your authentication server.
When using astartectl or any other client, you can also pass a Realm Private Key as an authentication mean, and have the token be automatically generated for you.
Accessing the APIs
In a standard Data Orchestrator installation, AppEngine API and Realm Management API are usually accessible at api.<your astarte domain>/appengine and api.<your astarte domain>/realmmanagement.
If your Data Orchestrator installation has Swagger UI enabled, you can use the /swagger endpoint to access it, and to issue API calls straight from your browser to follow this guide.