GET /signals – Databoom

L'API per recuperare la lista segnali è la seguente

GET https://api.databoom.com/v1/signals/

Per effettuare la chiamata è sufficiente un OAuth token con permessi di Lettura.

E' possibile specificare alcuni parametri per modificare i risultati della chiamata:

page e per_page permettono di specificare la pagina della lista richiesta ed il numero di segnali per pagina
populatePermission restituisce i permessi sui singoli segnali
showHiddenElements restituisce anche i segnali impostati come nascosti

La stessa chiamata in cURL si presenta come

  curl -X GET 'https://api.databoom.com/v1/signals/?page=2&per_page=100&populatePermission=true&showHiddenElements=true'
  -H 'Authorization: Bearer <OAuth Token>'

L'API risponde con la lista impaginata dei segnali accessibili all'utente.

Un esempio di risposta è il seguente, l'unico segnale presente è la pressione del dispositivo meteo di Trento.

Di particolare importanza nell'utilizzo delle API sono gli _id degli elementi, necessari per referenziare gli elementi stessi all'interno delle richieste. Se, ad esempio, ho bisogno di recuperare i dati del segnale Pressione di Trento, dovrò utilizzare il suo _id nella chiamata POST /chart.

{
  "data": [
        {
            "_id": "5aa2533bae696741894be82f",
            "device_token": "6541469",
            "signal_token": "pressure",
            "device": {
                "description": "Trento (IT)",
                "device_token": "6541469",
                "com_status": "ACTIVE",
                "tags": [],
                "_id": "5a5a149487761f00012647fe"
            },
            "device_description": "Trento (IT)",
            "description": "pressure",
            "permissions": [
                {
                    "user_id": "566936fc31a69bc412714727",
                    "roles": "CREATOR",
                    "_id": "5a5a149487761f0001264800",
                    "max_chart_history": 0,
                    "fake": false,
                    "is_a_team_member": false
                }
            ],
            "public_obj": true,
            "deleted": false,
            "type": "5718ca3f4ef29d440851589b",
            "status": "ACTIVE",
            "last_recived_value": 1019,
            "last_conn": "2019-05-07T09:41:00.000Z",
            "device_lower_description": "trento (it)",
            "device_token_low": "6541469",
            "bookmarked": false,
            "hidden": false,
            "lower_description": "pressure",
            "last_value_elaborated": 1019,
            "role": "VIEW"
        }
  ],
  "pages": {
  },
  "total_items": 1
}

GET https://api.databoom.com/v1/signals/

0 Commenti