Source API For Sensors

An API, or Application Programming Interface, is a set of rules and protocols that enables different software applications to communicate with each other. It defines the methods and data formats that applications use to request and exchange information, allowing developers to integrate various systems, access web services, and add functionality without starting from scratch.

The Source API for sensors is a technical interface that allows sensor providers to integrate seamlessly with the Source ecosystem. Once onboarded and authorized by a grower, the sensor provider can create sensors within the Source system and send measurements through the API, which the grower can then use within Source products.

• Authorization
  The Source API for sensors uses the OAuth2 Client Credentials flow for authentication.

• Companies
  The List companies request can be used to retrieve the authorized companies and their company IDs for which the sensor provider can create sensors and can submit measurements.  

• Measurement types
  The List measurement types request can be used to retrieve the supported measurement types of the Source API for sensors. 

• Sensors
  The Create sensor request can be used to create a sensor at the appropriate company. To create a sensor, you must enter: “serial” (Unique identifier of the sensor in the sensor provider’s backend), “companyId” (Unique identifier of the company in the Source.ag backend), “name” (name of the sensor). After creating the sensor, you will receive the “sensorId”. 

Measurements
The submit measurements request can be used to upload measurements to Source.ag. The measurements can be uploaded in bulk format. Each measurement must consist of: “timestamp” (Date-time with timezone in ISO 8601 format), “measurementType” (Name of the measurement type), “sensorId” (Unique identifier of the sensor in Source.ag backend), “value” (Measurement value)

The Source API for Sensors supports integration with many sensor manufacturers. If your sensors are from a manufacturer not on our partner list, please contact us, and we will contact your sensor supplier about the possibilities of integrating with Source.