AROYA Public API Overview
The AROYA Public API provides clients with the ability to retrieve their data from AROYA. This data can be used for third party integrations, data retrieval and safe
keeping, and in certain cases to potentially make control decisions with local hardware.
The first step to using the AROYA API is obtaining an API key from customer support. API Keys are associated with a particular user in the system and have the same
permissions as that user. We recommend creating a generic API User in AROYA and giving it access to whatever facilities/permissions the specific API needs to have, and
no more.
The AROYA API is a REST API. All requests made to the AROYA API must use an Authorization: Bearer <token> header to authenticate themselves. The
/validate/ endpoint can be used to ensure successful authentication with a specific API key.
The list of endpoints available for the AROYA API are listed here.
From there, clicking on any specific endpoint will list the query parameters, if any, that are available for filtering/searching/ordering of the response, and there will also be a response section that shows the shape of the response one can expect from the specific endpoint.
