Skip to main content

URL Structure

The API follows a sequential/layered URL structure, with data returned in a 'top-down' order. Data in the system is primarily structured around an Application, which is the top level for data requests. See API Map for more info.

Applications available to the current token can be viewed with the /access endpoint:

GEThttps://api.weightron.cloud/access

An application can be accessed from the application endpoint using the ApplicationID:

GEThttps://api.weightron.cloud/<ApplicationID>

The base request will return the Application object from the database, including the name and address details. This URL can be extended to include additional steps for additional data, such as.

GEThttps://api.weightron.cloud/<ApplicationID>/collections
GEThttps://api.weightron.cloud/<ApplicationID>/collections/<CollectionID>
GEThttps://api.weightron.cloud/<ApplicationID>/collections/<CollectionID>/documents
GEThttps://api.weightron.cloud/<ApplicationID>/collections/<CollectionID>/documents/<DocumentID>

Using GET, all requests will return an array of data corresponding with that endpoint unless an ID is provided, then a single object is returned instead. The store endpoints are the only exception to this, files can only be accessed individually with an ID.