New fields, updated descriptions and minor changes (#621)
New fields was added to the platform, and need to be available for use by the connector. Field description was updated to include Qods (previously, only buttons was described). Website and privacy policy was moved to a dedicated ressource. Readme was modified to reflect changes.
This commit is contained in:
Skiply
GitHub
Родитель
5dc719b4e3
Коммит
57cf6872b1
|
|
@ -1,43 +1,56 @@
|
|||
|
||||
## Ubiqod by Skiply
|
||||
Ubiqod provides a simple and powerfull platform to connect your Skiply connected buttons or QR Codes to third party platforms.
|
||||
This connector will trigger a flow each time data is sent by a device belonging to the configured group.
|
||||
## Ubiqod by Skiply
|
||||
Ubiqod provides a simple and powerful platform to connect your Skiply IoT buttons and Qods to third party platforms. This connector triggers a flow every time data is sent by any of the IoT-devices or Qods belonging to the configured group.
|
||||
|
||||
## Prerequisites
|
||||
You will need the following to proceed:
|
||||
* A Microsoft Power Apps or Power Automate plan
|
||||
* An Ubiqod subscription with Skiply buttons activated
|
||||
The Ubiqod API Key can be found in the "Account" section of your Ubiqod backend.
|
||||
## Prerequisites
|
||||
To proceed, you need:
|
||||
* A Microsoft Power Apps or Power Automate plan
|
||||
* A Ubiqod subscription
|
||||
The Ubiqod API Key can be found in the "Account" section of your Ubiqod backend.
|
||||
|
||||
## Prepare your device
|
||||
Before adding the Ubiqod trigger in Power Automate, pay attention to the following points:
|
||||
* The connector will be linked to a group. Make sure at least one group exists in your Ubiqod backend.
|
||||
* If your device is not linked to a Label Template, the default label will apply.
|
||||
## Prepare your IoT-devices and Qods
|
||||
Before using the Ubiqod trigger in Power Automate, pay attention to the following points:
|
||||
* The connector will be linked to a group: make sure at least one group exists in your Ubiqod backend.
|
||||
* If an IoT-device or a Qod is not linked to a Code list, the raw value of the code will be sent (or buttons indexes for IoT-devices).
|
||||
* If an IoT-device or a Qod is linked to a Code list but the entered code is not defined in the related Code list, the raw value of the code will be sent (or buttons indexes for IoT-devices).
|
||||
|
||||
## Set up the connector
|
||||
* Add the trigger "When data is received from devices"
|
||||
* Enter your API Key if requested
|
||||
* From the list of Group Names, choose the Group that should contain the devices you want to listen to
|
||||
* Add the steps of your choice
|
||||
## Set up the connector
|
||||
* Select the trigger "When data is received from devices"
|
||||
* Enter your API Key if requested
|
||||
* From the Group field, select the Group containing the IoT-devices and/or Qods you want to listen to
|
||||
* Then add the steps of your choice
|
||||
|
||||
## Available fields
|
||||
The following fields are available for mapping:
|
||||
* Device Name: Device Name as defined in the Ubiqod platform. This name is also visible on the device itself.
|
||||
* Device Label: Device Label as defined in the Ubiqod platform. Can be an indoor location or any other element that idetifies the device.
|
||||
* Request Date: Date of the request from Ubiqod server.
|
||||
* Action Label: Label of the action. Can be the label of a button, or the label of a code, if code mode is activated.
|
||||
* Times Button Pressed: For non-code mode, indicates the number of times the same button has been pressed. Always at 1 in code mode.
|
||||
* Site Id: Ubiqod ID of the site associated with the device.
|
||||
* Site Label: Ubiqod label of the site associated with the device.
|
||||
* Badge: Will be 1 if badge was used, 0 otherwise.
|
||||
## Available fields
|
||||
The following fields are available for mapping:
|
||||
* Timestamp: datetime of Qod scanning or IoT-device message transmission
|
||||
* Identifier: identifier of the Qod or IoT-device (s/n)
|
||||
* Qod or IoT-device label: label of the Qod or IoT-device
|
||||
* Site ID: site ID the Qod or IoT-device is linked to
|
||||
* Site label: site name the Qod or IoT-device is linked to
|
||||
* Customer contact email: email of customer contact defined on Site
|
||||
* Customer contact phone: phone number of customer contact defined on Site
|
||||
* Site manager email: email of site manager defined on Site
|
||||
* Site manager phone: phone number of site manager defined on Site
|
||||
* Action value: code label or raw value if no such code defined in the related code list (button index for IoT-devices if no such code defined)
|
||||
* GPS condition: 1 if condition is valid, 0 if not -
|
||||
condition is valid when the user GPS position is under the validation distance from the site position, 0 if not or if the user refused to give its position
|
||||
* On-device condition: 1 if condition is valid, 0 if not - For IoT-device: condition is valid when magnetic badge has been swiped / For S-Qod: condition is valid when dynamic QR code has been scanned from the device and validated by the Ubiqod server
|
||||
* Code condition: 1 if condition is valid, 0 if not - condition is valid when the entered code is defined in the related code list
|
||||
* GPS value: if available, GPS coordinates of the user's position
|
||||
* Validation code value: if available, validation code label or raw value if no such code defined in the related code list
|
||||
* Number of presses: only for IoT-devices, number of times the button was pressed
|
||||
* Custom field_1: only for Qod with a form, value of field #1
|
||||
* Custom field_2: only for Qod with a form, value of field #2
|
||||
* Custom field_3: only for Qod with a form, value of field #3
|
||||
* Custom field_4: only for Qod with a form, value of field #4
|
||||
|
||||
## Normal mode vs code mode
|
||||
In the configuration of your device, you can force the use of code mode.
|
||||
If you press button 1 and button 2, in normal mode, 2 separate requests will be sent (one for each button). In code mode, this will only send one request, with code "12" (you can configure the associated Label in your Label Template).
|
||||
## Normal mode vs code mode (only for IoT-devices)
|
||||
In the configuration of your IoT-device, you can force the use of “code mode”.
|
||||
If you press button 1 and button 2, in “normal mode”, 2 separate requests are sent (one for each button). In “code mode”, the same sequence of presses only sends one request, with code "12" (you can configure the associated label in your Code list).
|
||||
|
||||
## Test the connection
|
||||
* Tests accounts include virtual devices which behave in exactly the same way as physical devices. Press the "calculator button" in the device list to launch the simulator. Press one or more buttons, and wait until the 3 green lights stay on for one second (usually 10 seconds after the first press).
|
||||
## Test the connection
|
||||
* Ubiqod accounts include virtual devices which behave exactly the same way as IoT-devices. Press the "play button" in the IoT-device list to launch the simulator. Press one or more buttons, and wait until the 3 green lights stay on for one second (usually 4 seconds after the first press).
|
||||
|
||||
## Supported Operations
|
||||
The connector supports only one public operation:
|
||||
* DataIn (triggered each time that a button send data)
|
||||
## Supported Operations
|
||||
The connector supports only one public operation:
|
||||
* DataIn (triggered every time a button sends data)
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "Ubiqod by Skiply",
|
||||
"description": "Ubiqod provides a simple and powerfull platform to connect your Skiply connected buttons or QR Codes to third party platforms. This connector will trigger a flow each time data is sent by a device belonging to the configured group.",
|
||||
"description": "Ubiqod provides a simple and powerful platform to connect your Skiply IoT buttons and Qods to third party platforms. This connector triggers a flow every time data is sent by any of the IoT-devices or Qods belonging to the configured group.",
|
||||
"contact": {
|
||||
"name": "Skiply Support",
|
||||
"url": "https://desk.zoho.com/portal/skiply",
|
||||
|
|
@ -60,46 +60,108 @@
|
|||
"properties": {
|
||||
"device_name": {
|
||||
"type": "string",
|
||||
"description": "Device Name as defined in the Ubiqod platform. This name is also visible on the device itself.",
|
||||
"title": "Device Name"
|
||||
"description": "Identifier of the Qod or IoT-device (s/n)",
|
||||
"title": "Identifier"
|
||||
},
|
||||
"device_label": {
|
||||
"type": "string",
|
||||
"description": "Device Label as defined in the Ubiqod platform. Can be a place or anything helping to identify the device.",
|
||||
"title": "Device Label"
|
||||
"description": "Label of the Qod or IoT-device.",
|
||||
"title": "Qod or IoT-device label"
|
||||
},
|
||||
"request_date": {
|
||||
"type": "string",
|
||||
"description": "Date of the request from Ubiqod server.",
|
||||
"title": "Request Date"
|
||||
"description": "Datetime of Qod scanning or IoT-device message transmission.",
|
||||
"title": "Timestamp"
|
||||
},
|
||||
"button_label": {
|
||||
"type": "string",
|
||||
"description": "Label of the action. Can be the label of a button, or the label of a code, if code mode is activated.",
|
||||
"title": "Action Label"
|
||||
"description": "Code label or raw value if no such code defined in the related code list (button index for IoT-devices if no such code defined).",
|
||||
"title": "Action value"
|
||||
},
|
||||
"times_button_pressed": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "For non-code mode, indicates the number of times that the same button has been pressed.",
|
||||
"title": "Times Button Pressed"
|
||||
"description": "Only for IoT-devices, number of times the button was pressed ",
|
||||
"title": "Number of presses"
|
||||
},
|
||||
"site_id": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "Ubiqod ID of the site associated with the device.",
|
||||
"description": "Site ID the Qod or IoT-device is linked to.",
|
||||
"title": "Site Id"
|
||||
},
|
||||
"site_label": {
|
||||
"type": "string",
|
||||
"description": "Ubiqod label of the site associated with the device.",
|
||||
"title": "Site Label"
|
||||
"description": "Site name the Qod or IoT-device is linked to.",
|
||||
"title": "Site label"
|
||||
},
|
||||
"badge": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "Will be 1 if badge was used, 0 if not.",
|
||||
"title": "Badge"
|
||||
"description": "1 if condition is valid, 0 if not - For IoT-device: condition is valid when magnetic badge has been swiped / For S-Qod: condition is valid when dynamic QR code has been scanned from the device and validated by the Ubiqod server.",
|
||||
"title": "On-device condition"
|
||||
},
|
||||
"customer_contact_email": {
|
||||
"type": "string",
|
||||
"description": "Email of customer contact defined on Site.",
|
||||
"title": "Customer contact email"
|
||||
},
|
||||
"customer_contact_phone": {
|
||||
"type": "string",
|
||||
"description": "Phone number of customer contact defined on Site.",
|
||||
"title": "Customer contact phone"
|
||||
},
|
||||
"site_manager_email": {
|
||||
"type": "string",
|
||||
"description": "Email of site manager defined on Site.",
|
||||
"title": "Site manager email"
|
||||
},
|
||||
"site_manager_phone": {
|
||||
"type": "string",
|
||||
"description": "Phone number of site manager defined on Site.",
|
||||
"title": "Site manager phone"
|
||||
},
|
||||
"gps_condition": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "1 if condition is valid, 0 if not - condition is valid when the user GPS position is under the validation distance from the site position, 0 if not or if the user refused to give its position.",
|
||||
"title": "GPS condition"
|
||||
},
|
||||
"code_condition": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "1 if condition is valid, 0 if not - condition is valid when the entered code is defined in the related code list.",
|
||||
"title": "Code condition"
|
||||
},
|
||||
"gps_value": {
|
||||
"type": "string",
|
||||
"description": "If available, GPS coordinates of the user's position.",
|
||||
"title": "GPS value"
|
||||
},
|
||||
"validation_code_value": {
|
||||
"type": "string",
|
||||
"description": "If available, validation code label or raw value if no such code defined in the related code list.",
|
||||
"title": "Validation code value"
|
||||
},
|
||||
"custom_field_1": {
|
||||
"type": "string",
|
||||
"description": "Only for Qod with a form, value of field #1.",
|
||||
"title": "Custom field 1"
|
||||
},
|
||||
"custom_field_2": {
|
||||
"type": "string",
|
||||
"description": "Only for Qod with a form, value of field #2.",
|
||||
"title": "Custom field 2"
|
||||
},
|
||||
"custom_field_3": {
|
||||
"type": "string",
|
||||
"description": "Only for Qod with a form, value of field #3.",
|
||||
"title": "Custom field 3"
|
||||
},
|
||||
"custom_field_4": {
|
||||
"type": "string",
|
||||
"description": "Only for Qod with a form, value of field #4.",
|
||||
"title": "Custom field 4"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -117,8 +179,8 @@
|
|||
"description": "Subscribe response"
|
||||
}
|
||||
},
|
||||
"summary": "When data is received from devices",
|
||||
"description": "This operation triggers when one of the devices in the target group sends data.",
|
||||
"summary": "When data is received from IoT-device or Qod",
|
||||
"description": "This operation triggers when one of the IoT-devices or Qods in the target group sends data.",
|
||||
"x-ms-visibility": "important",
|
||||
"x-ms-trigger": "single",
|
||||
"operationId": "DataIn",
|
||||
|
|
@ -243,11 +305,11 @@
|
|||
"x-ms-connector-metadata": [
|
||||
{
|
||||
"propertyName": "Website",
|
||||
"propertyValue": "https://www.skiply.eu/en"
|
||||
"propertyValue": "https://www.ubiqod.com/"
|
||||
},
|
||||
{
|
||||
"propertyName": "Privacy policy",
|
||||
"propertyValue": "https://www.skiply.eu/en/terms-and-conditions-of-use/"
|
||||
"propertyValue": "https://www.skiply.eu/en/privacy-policy-of-ubiqod/"
|
||||
},
|
||||
{
|
||||
"propertyName": "Categories",
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче