Aggiornamento, eliminazione ed esecuzione mediante l'API
 |
Negli esempi riportati in questo argomento si presuppone che si abbia familiarità con l'esecuzione di POST HTTP nel proprio ambiente di sviluppo o nella propria applicazione Web.
|
Le regole riportate di seguito aiutano a capire ciò che è necessario in base al tipo di richiesta che si fa.
|
Note
|
URL di esempio
|
Azione HTTP
|
Tipo di contenuto
|
|||
|---|---|---|---|---|---|---|
|
AGGIORNAMENTO
|
Per gli aggiornamenti è necessario specificare anche la parte di entità
|
http://host/Thingworx/Things/thing_name
|
INSERIMENTO
|
applicazione/json o testo/xml
|
||
|
ELIMINAZIONE
|
Per l'eliminazione è necessario specificare anche la parte di entità
|
http://host/Thingworx/Things/thing_name
|
ELIMINAZIONE
|
n/d
|
||
|
CHIAMATA DI SERVIZI
|
Per chiamare un servizio è necessario specificare l'URL completo, incluse le caratteristiche specifiche
|
http://host/Thingworx/Things/MyThing/Services/myService
|
POST
|
applicazione/json
|
Esecuzione di richieste HTTP
Quando si eseguono richieste HTTP, utilizzare la codifica UTF-8 e specificare il valore di porta facoltativo se necessario.
 |
Si consiglia di utilizzare HTTPS nella produzione o in tutti i casi in cui l'integrità di rete è a rischio.
|
Gestione dei codici di risposta HTTP
Nella maggior parte dei casi viene restituito il contenuto o visualizzato il codice di stato 200. Questo comportamento è perfettamente normale. In caso di errore viene visualizzato un messaggio di errore.
Utilizzo del contenuto HTTP
Se si invia o si riceve contenuto HTTP (JSON, XML, HTML (solo per le risposte)), impostare l'intestazione del tipo di contenuto della richiesta sul valore appropriato in base al contenuto HTTP che si sta inviando.
|
Metodi
|
|
|---|---|
|
GET
|
Recuperare un valore.
|
|
INSERIMENTO
|
Immettere un valore oppure creare proprietà o oggetti nuovi.
|
|
POST
|
Eseguire un servizio.
|
|
ELIMINAZIONE
|
Eliminare un oggetto o una proprietà.
|
|
Valori dell'intestazione Accept
|
|
|---|---|
|
JSON
|
applicazione/json
|
|
XML
|
testo/xml
|
|
HTML
|
testo/html (o omettere l'intestazione Accept)
|
|
CSV
|
testo/csv
|
|
Valori di intestazione del tipo di contenuto
|
|
|---|---|
|
JSON
|
applicazione/json
|
|
XML
|
testo/xml
|
Metadati
È possibile visualizzare i metadati di qualsiasi forma, modello di oggetto o oggetto specifici creati accedendo all'URL NameoftheThing/Metadata in un browser Web.
|
|
Per visualizzare queste informazioni, è necessario che siano visualizzate come JSON.
|
Autenticazione con la chiamata API REST
La best practice consigliata consiste nell'utilizzare una chiave di accesso. Generare la chiave di accesso in ThingWorx, quindi è possibile trasmetterla con la chiamata REST sotto forma di intestazione HTTP.
Sostituire il Valore intestazione con la chiave di accesso valida per l'istanza di ThingWorx che si intende connettere.
|
Chiave intestazione
|
Esempio valore di intestazione
|
|---|---|
|
appKey
|
1x9256cf-9fe9-434e-adbe-9772c0c40261
|
L'API REST di ThingWorx supporta altri due metodi di autenticazione.
• L'autenticazione di base consente di eseguire l'autenticazione con il nome utente e la password.
• Trasferimento della chiave di accesso come parametro URL. Questo metodo non è consigliato per motivi di sicurezza e sarà deprecato in futuro.
Link correlati