Skip to main content

Logo

API Docs

This documentation aims to guide you through each step of using our API, to help build custom apps and integrations to get data from our platform.

Use the sidebar on the left to navigate through the articles, and contact us if you encounter any issues.

Where to start?​

If you are looking to get started with the API, we recommend starting with the Requesting Access article. This is a good place to start as you'll need to request a set of OIDC credentials to use the API.

Structure​

The API follows a sequential/layered URL structure. We recommend familiarising yourself with the URL Structure of API requests, and the Response Format to expect from your requests.

Authentication​

Weightron.Cloud is secured with an OpenID Connect implementation with the OAuth 2.0 authorization protocol. All API requests require a valid Access Token, retrieved from the OIDC Auth server. Checkh our article on Authentication for more information on how to authenticate with the API.