This guide will step you through the process of getting started with OpenGate North and South APIs.
You have to ask to the OpenGate Platform administrator to obtain:
Admin Information:(This information is not necessary to perform most of the operations with the API because this is obtained internally by the API through the API Key)
Your Organization Identifier (or Customer Id)
A Channel Identifier in which the device will be grouped
If you have your own OpenGate platform in your site, you can use the Organization and Channel identifiers that are provisioned with the default installation of the Platform: * Organization: base_organization * Channel: base_channel
or create new ones:
A Device Identifier: As an string that will identify the device into a Organization. We will use in the examples:
If the user (API_KEY) you have, has enough permissions on the organization you can provision the devices using North API provision. See how to provision devices. Remember to use your own device id.
In both cases (North and South API) you have to ask to the OpenGate Platform administrator for two different API Keys. One for applications (North) API and one for devices (South) API.
If you have enough permissions you can create new users (with their respective API Keys. See how to provision users
The API Key is a unique identifier all over the platform generated by the administrator which uses the UUID format
This identifier looks like:
To a quick start we propose using CURL that is a widely used tool to perform most types of WebService Interactions from a command line console. You can find a lot of documentation about CURL tool in its project home page
If you’re using a Linux flavour, CURL is probably already installed.
If you are not familiar with CURL and you have an Internet OpenGate API access try hurl.
Use the South API from a specific device to write and store data. See how to collect IoT information from devices
Use the South API from a specific device to write and store data. See how to collect DMM information from devices
Use the North API from your applications in order to read the data sent from a specific device.See how to search collected IoT information
Use the North API from your applications in order to read the data sent from a specific device. See how to search collected DMM information