Overview

Ayyeka FAI API is a secured HTTP Rest-API that uses resource-oriented endpoints to call the API.

The Rest-API is responding with standard HTTP response codes indicating the success or failure of the request. For requests of type HTTP GET request, will return the payload in JSON format. Users can learn more about the specific requests by going to API Reference.

Under API Reference user will find a list of resources that can be divided into two groups as follows:

Metadata

Group of resources that represent physical and logical entities in the platform for a specific account.

Resource	Description	Example
`account`	A resource that represents a tenant in the FAI platform named Account	Get all organizations belonging to the account link
`channel`	A resource that represents a logical entity of device wiring(channel_type,channel_num) in the FAI platform	Get all channels by device serial number link
`device`	A resource that represents a physical entity of a device in the FAI platform	Get device info by device serial number link
`site`	A resource that represents a logical entity of an installation site of the device in the FAI platform	Get all sites in account link
`stream`	A resource that represents a logical entity of a stream of samples with the same type of data from a specific site.	Get all streams in a site link
`user`	A resource that represents a logical entity of a user in FAI platform	Get all users in account link

Data - resources that represent the field data like sample, samplerfid and sampleimage , it is required to provide metadata identifiers in order to fetch field data.

Resource	Description	Example
`sample`	A resource that you call to get samples from the field of type scalar.	Get a batch of new scalar samples stored on the FAI platform since the last call to RestAPI link
`sampleimage`	A resource that you call to get samples from the field of type image.	Get a batch of new image samples stored on the FAI platform since the last call to RestAPI link
`samplerfid`	A resource that you call to get samples from the field of type RFID.	Get a batch of new RFID samples stored on the FAI platform since the last call to RestAPI