To create a new integration you must go to the Network management page and press the following buttonon the right side of the page. You only need to specify the network's name.
Only you are able to view your networks. If you with to make your networks public, contact us through our Support Center.
Once you have the network created, you have several parameters that you can use. If you want to keep the network private for your account only, you don't need to fill all of them.
- Name: Network name.
- Description: Network description.
- Documentation Link: external link for documentation on how to use it. Preferably on TagoIO's community page.
- Icon: Icon of the network, to show up in the sidebar.
- Banner: Banner of the network, to show up when the network is selected.
You can turn the serial number to required or not. If not required, the user will not be requested to enter a serial number. Usually you will want this to be on.
The serial number allows you to get the device using your network token. Then you can insert data to the device.
- Label: serial number label, like Device EUI, Serial, IMEI, etc.
- Format: Unique format of the serial number. It restricts the length of the serial number and the values allowed.
A few keywords are allowed:
F: Hexadecimal value.
A: Alphabet value.
0: Number value.
-: Hifen is just for user visualization, this value is not stored in the serial number.
So, for example, if I want the serial number to be a sixteen length hexadecimal value, as it is used in Device EUI, I can write this way:
- Image: Image example to help the user find the serial number.
- Force Case: To force the serial number to be Lowercase or Uppercase.
Device parameters are useful ways to set some parameters to connectors created using your Network.
You can set it as a Number, Text, Dropdown or Switch, which you can access later in the payload parser.
Here is an example with dropdown on how it looks in the user view:
Check the Payload parser context overview to see how to get this information on the payload parser.
Tokens and getting the devices
Here you can generate tokens for your network. You will need the token to get access to devices created in your network. The token will have no use if you're not using Serial Number, as the serial number is required to use this functionality.
- Authorization: Connector-token
- Serial number: The serial number used in the device creation.
- Authorization (Optional): The user account Authorization, required to have access to any device in the user's account. We strongly recommend use it for security purposes.
Response HTTPs Header 200:
The result of the request is the device token, which you can use to send the data with the HTTP's data post.
If you will be sending raw payload data, please follow the instructions bellow in order to keep it compatible with all TagoIO connectors.
- Send the variable as payload.
- Always send the value as hexadecimal.
The payload parser for the Network doesn't work any differently from the payload parser for devices. All of the same rules are applied here.
If you're sending data to TagoIO in the correct format, there is not much to do here. But if you're sending a text file, or an unsupported JSON format, it is best to handle this here before going to the device connector.
Some integrations do not send the payload in hexadecimal, and in the payload parser you can easily change it to hex in order to keep the compatibility with all other connectors.
Creating a connector
Now all you need to do to start using your network is to create a connector.
The network is the way the device will be connecting to TagoIO, the connector is what the device is.
After creating your connector, you will be able to start creating devices with the connector and network you've made.