API access and tokens
Email support@augos.io to request access. The token is bound to a user profile and can only see what that profile can see, so the user's access has to be right first. Tokens are valid for twelve months and are re-issued manually.
Two things to get right before anything else
1. Authorisation. A request from an integrator, consultant or contractor is not actioned on its own. It has to be authorised by the customer who owns the site. Copy the account holder into the request and Augos will wait for their confirmation.
2. Scope. The token inherits the requesting user's point-level access. If that user has been given the site virtual point and one measurement point, the integration will silently return far less than expected, and it will look like a data problem rather than a permissions one.
Decide which points the integration actually needs. On a large estate, granting everything makes the payload unwieldy for no benefit. Support will ask which points or areas you want rather than granting the lot by default.
Requesting access
Send support@augos.io:
- Which user profile the token should be bound to, or the details for a new one.
- Which points or areas the integration needs.
- What you are building, briefly. It helps support flag a scope mismatch early.
You will receive a bearer token by email, along with the Augos API information document.
Expiry
Tokens are valid for twelve months from issue and then stop working. There is no
self-service rotation and no expiry warning, so diarise the renewal date the day
you receive the token. Renewal is a request to support@augos.io and is usually
turned around within the hour.
An authentication failure on a previously working integration is almost always expiry. Check the issue date before investigating anything else.
Handling
When an integrator leaves, email support@augos.io and ask explicitly for the token
to be invalidated as well as the user removed. The token is scoped by the user's
access, but do not assume that removing the user is by itself enough to stop an
already-issued token working.
Still stuck
Email support@augos.io with the user profile, the points required, and the
authorisation from the account holder if you are a third party.