× IMPORTANT : The authentication API has changed. The API returns no longer the authentication token. Please, find yours in on your developer dashboard, in 'My Account' tab.

Developer Authentication rely on Basic HTTP Auth based on login / password combination provided at registration step. Your authentication token is available in your developer's account, in 'My Account' tab.

Header Description
Authorization: Basic XXXX Either Standard http auth token computation, or remote WS authentication result content



GET | POST /security/authentication


Description
Developer Authentication operation
Url
https://sensor.insgroup.fr/security/authentication
Method
GET or POST
Parameters
None, login and password are passed in Basic Authentication header.
Returns
void
Errors
  • 404 - The developer account was not found
  • 401 - The authentication information are missing or invalid



POST /iot/developers/updatePassword.json


Description
Update developer's password : it must contain at least 6 characters, including uppercase, lowercase letters and numbers.
Url
https://sensor.insgroup.fr/iot/developers/updatePassword.json
Method
POST
Parameters
  1. email required Developer account login
  2. currentpwd required Current password
  3. newpwd required New password
  4. confirmpwd required Confirm new password
Returns
void
Errors
  • 404 - The developer account was not found
  • 401 - The authentication information are missing or invalid



POST /iot/developers/registerGit.json


Description
Update developer's git alias to access our GitHub repositories
Url
https://sensor.insgroup.fr/iot/developers/registerGit.json
Method
POST
Parameters
  1. email required Developer account login
  2. gitAlias required Developer git alias
Returns
void
Errors
  • 404 - The developer account was not found
  • 401 - The authentication information are missing or invalid

POST /iot/developers/pacs.csv


Description
Get all your registered modules' PAC serial numbers
Url
https://sensor.insgroup.fr/iot/developers/pacs.csv
Method
POST
Parameters
N.A
Returns
A text/plain stream with all your registered modules' PAC numbers.

Sample response :

SERIAL; PAC
1FA0; 5D467EB830D4C820
0C10; 4CA601D8D0D1A999
                        
Errors
  • 401 - The authentication token is invalid or missing



GET /iot/developers/apps.json


Description
Fetching developper apps
Url
https://sensor.insgroup.fr/iot/developers/apps.json
Method
GET
Parameters
N.A
Returns
Iot app list

Sample JSON response

[
    {
        "created": "Jul 3, 2012 12:00:00 AM", 
        "description": "Lot : 20120703", 
        "id": 12305378134, 
        "key": "3a0b8cb3dda65aba53839452ff09", 
        "name": "PACK TEST - BETA", 
        "reftime": "Jul 3, 2012 12:00:00 AM", 
        "secret": "eb46372bad4713e154f02800sffa0df0"
    }, 
    {
        "callbackurl": "http://my.backend.url/callback", 
        "created": "Oct 10, 2012 12:00:00 AM", 
        "description": "Application that rocks regroupant l'ensemble des \u00e9l\u00e9ments PROD. LOT livr\u00e9 le 10/10/2010", 
        "id": 12273973223323, 
        "key": "f9d373e1188fd373193a97206881886b", 
        "name": "20121010_COVEA_SMOKY", 
        "secret": "14cdec0d66304fdc451fepopoFd"
    }
]
                         
Errors
  • 404 - The developer account was not found
  • 401 - The authentication information are missing or invalid



POST /iot/developers/apps.json


Description
Iot app creation / update operation
Url
https://sensor.insgroup.fr/iot/developers/apps.json
Method
POST
Parameters
  1. app required Iot App json serialized

Sample creation request command

curl -X POST -H "Authorization: Basic Blablafootoken==" "http://sensor.insgroup.fr/iot/developers/apps.json" -d '{"name": "myApp", "description" : "My app description lines go here", "callbackurl" : "http://my.callback.url"}'
                       
Returns
Iot app created / updated

Sample JSON response body

{
    "callbackurl": "http://my.callback.url", 
    "created": "Mar 26, 2013 2:47:29 PM", 
    "description": "My app description lines go here", 
    "id": 125031196,
    "key": "610c86a7e20c22090983232377934fffddffde", 
    "name": "myApp", 
    "secret": "00343982122308dfcbaeffefed093409"
}
                      
Errors
  • 404 - The developer account was not found
  • 401 - The authentication information are missing or invalid



DELETE /iot/developers/apps.json


Description
Iot app deletion operation
Url
https://sensor.insgroup.fr/iot/developers/apps.json
Method
DELETE
Parameters
  1. id required Iot App technical id

Sample request command

curl -X DELETE -H "Authorization: Basic Blablafootoken==" "http://sensor.insgroup.fr/iot/developers/apps.json" -d '{}'
                       
Returns
void
Errors
  • 404 - The developer account was not found
  • 401 - The authentication information are missing or invalid



POST /iot/developers/modules.json


Description
Attach a single or multiple module(s) to the developer's account
Url
https://sensor.insgroup.fr/iot/developers/modules.json
Method
POST
Parameters
  1. modules required Iot Module(s) json serialized (serial, key). Key information appears either next to module sn information on product packaging sticker (8 hexa chars, case insentitive), either as a PAC sn given by your module provider (16 hexa chars, case insentitive).

Sample request command

curl -X POST -H "Authorization: Basic Blablafootoken==" "https://sensor.insgroup.fr/iot/developers/modules.json" -d '[{"serial": "1FA0", "key": "A87A1EEA"}]'
                            
Returns
A data structure with :
  1. a list of registered modules
  2. a list of not found modules
  3. a list of already registered modules
  4. a list of invalid keys

Sample JSON response body

{
    "registered":["1FA0"],
    "not_found":[],
    "already_registered":[],
    "invalid_key":[]
}
                            
Errors
  • 404 - The developer account was not found
  • 401 - The authentication information are missing or invalid



DELETE /iot/developers/modules.json


Description
Unregister a single module to the developer's account, and detach it to Iot Applications.
Url
https://sensor.insgroup.fr/iot/developers/modules.json
Method
DELETE
Parameters
  1. id required Iot Device technical id
  2. sn required Iot Device serial number

Sample request command

curl -X DELETE -H "Authorization: Basic Blablafootoken==" "http://sensor.insgroup.fr/iot/developers/modules.json" -d "id=92507426&sn=1FA0"
                       
Returns
void
Errors
  • 404 - The developer account was not found
  • 401 - The authentication information are missing or invalid



GET /iot/developers/device.json


Description
Get IOT informations of a device
Url
https://sensor.insgroup.fr/iot/developers/device.json
Method
GET
Parameters
  1. id required Iot Device technical id
  2. sn required Iot Device serial number
Returns
A data structure with an Iot Module.
Errors
  • 400 - Bad parameters



GET /iot/developers/modules.json


Description
Listing of all modules attached to the developer's account
Url
https://sensor.insgroup.fr/iot/developers/modules.json
Method
GET
Parameters
N.A

Sample request command

curl -X GET -H "Authorization: Basic Blablafootoken==" "https://sensor.insgroup.fr/iot/developers/modules.json"
                            
Returns
A data structure with a list of Iot Modules (technical id, serial) :

Sample JSON response body

[
    {
        "id":"92507426",
        "serial":"1FA0"
    }
]
                            
Errors
  • 404 - The developer account was not found
  • 401 - The authentication information are missing or invalid



POST /iot/developers/apps/{idApp}/modules/attach.json


Description
Modules attachment to an existing Iot App
Url
https://sensor.insgroup.fr/iot/developers/apps/{idApp}/modules/attach.json
Method
POST
Parameters
  1. idApp required Iot app's functional id
  2. modules required Modules to attach

Sample request command to attach modules : 1FA0 and 1019 to app with id : 123456789

curl -X POST -H "Authorization: Basic Blablafootoken==" "https://sensor.insgroup.fr/iot/developers/apps/123456789/modules/attach.json" -d '{"serials":["1019","1FA0"]}'
                            
Returns
void
Errors
  • 404 - The developer account was not found
  • 401 - The authentication information are missing or invalid



POST /iot/developers/apps/{idApp}/modules/detach.json


Description
Modules detachment to an existing Iot App
Url
https://sensor.insgroup.fr/iot/developers/apps/{idApp}/modules/detach.json
Method
POST
Parameters
  1. idApp required Iot app's functional id
  2. modules required Modules to detach

Sample request command to detach modules : 1FA0 and 1019 to app with id : 123456789

curl -X POST -H "Authorization: Basic Blablafootoken==" "https://sensor.insgroup.fr/iot/developers/apps/123456789/modules/detach.json" -d '{"serials":["1019","1FA0"]}'
                            
Returns
void
Errors
  • 404 - The developer account was not found
  • 401 - The authentication information are missing or invalid



GET /iot/developers/apps/{idApp}/modules.json


Description
Fetching app modules
Url
https://sensor.insgroup.fr/iot/developers/apps/{idApp}/modules.json
Method
GET
Parameters
  1. idApp required Iot app's functional id

Sample request command to fetch the idApp 123456789 modules

curl -X GET -H "Authorization: Basic Blablafootoken==" "https://sensor.insgroup.fr/iot/developers/apps/123456789/modules.json"
                            
Returns
A data structure with a list of Iot Modules (technical id, serial) :

Sample JSON response body

[
    {
        "id":"92507426",
        "serial":"1FA0"
    }
]
                            
Errors
  • 404 - The developer account was not found
  • 401 - The authentication information are missing or invalid



GET /iot/developers/decode


Description
Decode any UDM Frame
Url
https://sensor.insgroup.fr/iot/developers/decode
Method
GET
Parameters
  1. frame required Frame to decode
  2. protocol required Protocol to use (UDM22 or UDM23)

Sample request command to decode the following UDM22 (means "UDM 2.2 version") frame : 010000

curl -X GET -H "Authorization: Basic Blablafootoken==" "https://sensor.insgroup.fr/iot/developers/decode?frame=010000&protocol=UDM22"
                            
Returns
An IOT Callback structure with all your decoded informations in an extra zone. An empty result is returned if the frame is not valid.

Sample JSON response body

{
   "msg":{
      "extra":{
         "entry_id":0,
         "frame_type":"srv_frm_event",
         "code":"event_battery_low"
      },
      "custom":{}
   }
}
                            
Errors
  • 404 - The developer account was not found
  • 401 - The authentication information are missing or invalid