Connio

The Connio API Developer Hub

Welcome to the Connio API developer hub. You'll find comprehensive guides and documentation to help you start working with Connio API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    API Reference

Overview

Data Connector Overview

Data Connectors allow developers to stream incoming device data to different backend and data stores without writing any additional code. You can create multiple data connectors within an App to stream incoming data of devices plugged into this App. Currently we limit data connector per App by 10 connectors, in the future we might increase this limit.

Data Connectors are managed under their parent entities (i.e. App) as shown below:

GET .../v3/apps/:ref/dataconnectors
GET .../v3/apps/:ref/dataconnectors/:id
POST .../v3/apps/:ref/dataconnectors/test

// Payload should contain configuration object

// Any response code other than 200 should be considered failure
GET .../v3/apps/:ref/dataconnectors/:id/test

// No payload needed
POST .../v3/apps/:ref/dataconnectors
PUT .../v3/apps/:ref/dataconnectors/:id
DELETE .../v3/apps/:ref/dataconnectors/:id

SECURITY

Some data connectors' configuration contain sensitive information such as login credentials (i.e. username and password). For security reasons Connio does not return saved credentials in API responses. This precaution requires you to provide passwords every time you run a test on
POST .../v3/apps/:ref/dataconnectors/test endpoint. As a safe alternative, the platform exposes another test endpoint where you can run tests on saved data connectors without needing to provide any configuration value including credentials as shown below.

GET POST .../v3/apps/:ref/dataconnectors/:id/test

DISABLING DATA CONNECTORS

If an app is disabled, all its data connectors are disabled automatically. Alternatively you can disable data connectors one by one.

Data is streamed into data connectors in Data Value format. Single App method can be used to pre-process (i.e. to transform or to filter) incoming data before it is sent to the connector.

For example, you can create a custom object within the data processor method before you write it to your data store.

function preprocessor(value) {
 let myEvent = {
   device_context: value.destination.state,
   event: {
     feed_id: value.feedId,
     event_type: "onPropertyChanged",
     time: value.sourceTime,
     property_name: value.destination.property.name,
     property_new_value: value.value     
   }
 }
  
 return myEvent;  
}
function preprocessor(value) {
 if (value. destination.property.name == "temperature") {
   let myEvent = {
     device_context: value.destination.state,
     event: {
       feed_id: value.feedId,
       event_type: "onTemperatureChanged",
       time: value.sourceTime,
       property_name: value.destination.property.name,
       property_new_value: value.value     
     }
   }     
   return myEvent; 
 }
 else {
   // Filter out
   return null;
 } 
}

Data Connector config object consists of the following common attributes.

Attribute Description
type Connector type (e.g. HTTP, AMQP, etc..)
id App wide unique connector id.
*dataProcessingMethod Optional. Id or name of the App method that will be used for filtering and/or transforming incoming data.
disabled When true data connector stops streaming.

*Note that when you requested the data connector object, the response contains always the dataProcessingMethodId.

Additionally each data connector specifies its own relevant fields. See data connector page for details.

DATA CONNECTOR PERFORMANCE

Apps act like execution context for data connectors. If you have too many devices plugged into a singe app, or your devices are chatty, one data connector per app always give you the best performance.

You can always improve your scalability by limiting the number of devices plugged into an app, or number of data connectors created within an app.

Updated 23 days ago


What's Next

HTTP

Overview


Data Connector Overview

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.