Create a Cloud Connector
This article provides a high-level overview of the steps needed to create your own Cloud Connector. A Cloud Connector is a key ARTIK Cloud feature that bypasses third-party silos and enables true interoperability between devices from different manufacturers.
As a developer, you can build a Cloud Connector for any device that sends data to a third-party cloud. ARTIK Cloud can receive data from and send commands to the Cloud Connector, treating it as another device. Every cloud is now a node in the greater IoT ecosystem. Connected clouds benefit from Rules, analytics, and interactions with every device in the ARTIK Cloud ecosystem.
Whether you have a device that uses your proprietary cloud, or wish to connect your IoT solution to siloed devices, Cloud Connectors save you from developing custom integrations and let you focus on moving the data!
If you already understand the basic steps, you can start instead with one of the following:
- Using Cloud Connectors walks through these steps in greater detail.
- Your First Cloud Connector is a hands-on example of connecting to a third-party cloud. We use Moves for this Connector example.
Before starting, ensure that the third-party cloud provides subscription/notification APIs and public APIs to read data.
Step 1: Create a new device type
You need to define a Manifest for your device type. See the following for context:
Once this information is saved, navigate to Device Info and set the device data source to "cloud".
Step 2: Select the authentication protocol
In the Cloud Authentication tab, define how ARTIK Cloud authenticates with the third-party cloud:
- Custom (display a custom UI to manage user credentials)
- None (the cloud does not require authentication)
Your selection depends on the protocol supported by the third-party cloud, as specified in its documentation.
Step 3: Create an ARTIK Cloud Connector app
Create and configure an ARTIK Cloud Connector application on the third-party cloud, referring to its documentation for the appropriate steps (example).
You may then obtain the client ID and client secret needed for OAuth1 or OAuth2 authentication, if needed, and apply them in Step 2. This third-party application enables your Cloud Connector device type to interact with the third-party cloud.
Step 4: Write and submit your Connector Code
Broadly speaking, Connector Code uses the third-party APIs to:
- Subscribe to the third-party cloud
- Receive notifications from the cloud
- Fetch data from the cloud
In addition, you can send Actions to the Cloud Connector (which sends them to the third-party cloud) and define polling periods to schedule Actions (this can also be done in the Dashboard).
See the following for details:
- Example Connector Code from our tutorial Your First Cloud Connector.
- Implement a Cloud Connector provides documentation of the Cloud Connector API methods, including subscribe/notify, send messages, handle Actions, and other methods that can be modified according to your use case.
- Cloud Connector examples provides working sample code.
Step 5: Let us know!
Notify the ARTIK Cloud team about your new Cloud Connector. We will test your Cloud Connector and add it to our Works With page of verified devices.
After building the Cloud Connector, any user can connect it to their ARTIK Cloud account.
You might also want to add the Cloud Connector to an application. Here's how: