API applicazione

Per accedere alle API dello strumento, utilizzare i seguenti URL endpoint API. L'endpoint API URL è costituito da un host URL e da una base URL. Il sito URL di base per ogni API REST è elencato nella documentazione dell'API ed è in genere api/v0002/. Sono disponibili diverse API per lo sviluppo di codice per dispositivi, gateway e applicazioni che si collegano allo strumento.

Autenticazione API

L'API dell'applicazione HTTP è protetta dall'autenticazione di base HTTP. Utilizzare la chiave API generata dallo strumento.

Esempio: a-abc123-kodl0vqqrk, dove abc123 è il valore {orgId} . Il token generato dallo strumento.

Il valore {orgId} è l'ID dell'organizzazione dello strumento a 6 caratteri. Il valore {orgId} deve essere incluso nel nome host per qualsiasi chiamata API HTTP. Se si utilizza Dedicated, l'ID dell'organizzazione viene fornito nella lettera di benvenuto. Se sei in un ambiente gestito dal cliente, il tuo ID organizzazione è il tuo ID di lavoro. L'amministratore della suite di applicazioni configura l'ID dello spazio di lavoro durante il processo di installazione.

Per ulteriori informazioni sulle chiavi API e sui token per le applicazioni, vedi Utilizzo delle applicazioni. È possibile cercare la chiave API e il token predefiniti nello strumento.

HTTP API URL

L'host URL è il seguente:

https://{orgId}.iot.masdomain.com/{base_URL}

Esempio di Curl

Il seguente esempio è un esempio di una chiamata API per elencare i dispositivi nella tua organizzazione: curl -X GET "https://{orgId}.iot.masdomain.com/api/v0002/bulk/devices?_limit=25" -u '{username}:{password}'