This API uses OAuth 2.0 for authentication. To authenticate your requests, you need to obtain a JSON Web Token (JWT) by sending a request to the following endpoint:

POST https://auth.tbmaestro.com/oauth/token

Please, note that the authentification endpoint is different from the API endpoint. You must provide your credentials (client ID and secret) to obtain a JWT.

The API uses scopes for authorizing requests. Two scopes are available: api:read and api:write. These scopes grant read and write access to the API, respectively. Your may request either of these scopes from the authentication endpoint, provided it is included in your plan.

The body of the request should look like this:

Key	Value
grant_type	client_credentials
client_id	Your client ID.
client_secret	Your client secret.
audience	https://backendmya.tbmaestro.com
scopes	One of api:read or api:write.

The response payload should look like this:

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsIm...",
  "scope": "api:read",
  "expires_in": 3600,
  "token_type": "bearer"
}

All requests to the API must include the JWT in the Authorization header, prefixed with Bearer:

POST https://backendmya.tbmaestro.com/graphql
Authorization: Bearer <YOUR_TOKEN_HERE>

API conventions

The API is organized around entities which may be linked together. The most important entities are Asset and Organization. All entities are linked to an organization, most are also linked to an asset. See the API's types reference for details on each type of entity.

All entities feature the same base fields:

id

The unique ID of the entity. This is the ID used to refer to the entity in most API calls. Note that some entities may have some other sort of unique identifier, either generated or manually assigned.

properties

This object contains all the properties of the entity. Properties are configurable. When an organization is created in myA, it comes with a set of default properties for all entities. New properties may be configured in myA. See the user guide for more information on how to manage properties.

computedProperties

This object contains all the computed properties of the entity, also referred to as "indicators". Like properties, indicators are configurable, but contrary to the former, they are read-only and their value is computed automatically based on a formula.

creationActor

This object contains data about the user or client who created the entity:

{
  "actorId": "10@users",
  "name": "John Doe"
}

lastChangeActor

This object contains data about the user or client who last updated the entity.

creationDate

This is the ISO-8601 date and time at which the entity was created.

lastChangeDate

This is the ISO-8601 date and time at which the entity was last updated.

This API relies on GraphQL WS for handling subscriptions over WebSockets. Look for the implementation most suitable to your project. The endpoint for subscriptions is wss://backendmya.tbmaestro.com/graphql. For authenticating subscriptions, a connection_init message containing the JWT must be sent over the WebSocket first:

{
  "type": "connection_init",
  "payload": {
    "Authorization": "Bearer <YOUR_TOKEN_HERE>"
  }
}

Warning: This is the only accepted way to authenticate subscriptions. The Authorization header in the WSS request is ignored by GraphQL WS. Note that some GraphQL clients such as Postman do not support GraphQL WS natively and subscriptions may not work as expected.