Mise à jour, suppression et exécution via l'API
 |
Les exemples de cette rubrique partent du principe que vous savez comment exécuter des requêtes HTTP POST dans votre environnement de développement Web ou dans votre application.
|
Les règles suivantes permettent de comprendre quels éléments sont nécessaires en fonction du type de demande émise.
|
Remarques
|
Exemple d'URL
|
Action HTTP
|
Type de contenu
|
|||
|---|---|---|---|---|---|---|
|
UPDATE
|
Pour les mises à jour, les entités doivent également être définies.
|
http://host/Thingworx/Things/thing_name
|
PUT
|
application/json ou text/xml
|
||
|
DELETE
|
Pour les suppressions, les entités doivent également être définies.
|
http://host/Thingworx/Things/thing_name
|
DELETE
|
n/a
|
||
|
INVOKING SERVICES
|
L'appel d'un service nécessite de spécifier l'URL complète, y compris le nom du service.
|
http://host/Thingworx/Things/MyThing/Services/myService
|
POST
|
application/json
|
Exécution des requêtes HTTP
Pour exécuter des requêtes HTTP, utilisez le codage UTF-8 et spécifiez si nécessaire la valeur de port (facultatif).
 |
L'utilisation du HTTPS est recommandée en production ou dès lors qu'il s'agit de préserver l'intégrité du réseau.
|
Gestion des codes de réponse HTTP
Dans la plupart des cas, vous devriez obtenir le contenu ou le code d'état 200 (le code OK). En cas d'erreur, vous recevrez un message d'erreur.
Utilisation du contenu HTTP
Si vous êtes émetteur ou récepteur de tout type de contenu HTTP (JSON, XML, HTML (pour les réponses uniquement)), définissez l'en-tête de requête Content-Type sur la valeur correspondant au contenu HTTP que vous envoyez.
|
Méthodes
|
|
|---|---|
|
GET
|
Récupérez une valeur.
|
|
PUT
|
Entrez une valeur ou créez de nouveaux objets ou propriétés.
|
|
POST
|
Exécutez un service.
|
|
DELETE
|
Supprimez un objet ou une propriété.
|
|
Valeurs d'en-tête Accept
|
|
|---|---|
|
JSON
|
application/json
|
|
XML
|
text/xml
|
|
HTML
|
text/html (ou ignorez l'en-tête Accept)
|
|
CSV
|
text/csv
|
|
Valeurs d'en-tête Content-Type
|
|
|---|---|
|
JSON
|
application/json
|
|
XML
|
text/xml
|
Métadonnées
Vous pouvez afficher les métadonnées de tout objet, modèle d'objet ou forme spécifique que vous construisez en accédant à l'URL suivante dans un navigateur Web : NameoftheThing/Metadata
|
|
Ces informations doivent être affichées au format JSON pour être consultées.
|
Transmission de données d'authentification avec votre appel d'API REST
Il est recommandé d'utiliser une clé d'application. Générez-la dans ThingWorx avant de la transmettre avec votre appel REST sous la forme d'un en-tête HTTP.
Remplacez la valeur d'en-tête par la clé d'application valide pour l'instance ThingWorx que vous souhaitez connecter.
|
Clé d'en-tête
|
Exemple de valeur d'en-tête
|
|---|---|
|
appKey
|
1x9256cf-9fe9-434e-adbe-9772c0c40261
|
L'API REST ThingWorx prend en charge deux autres méthodes d'authentification :
• L'authentification de base vous permet de vous authentifier avec votre nom d'utilisateur et votre mot de passe.
• La transmission de la clé d'application sous la forme d'un paramètre d'URL. Cette méthode n'est pas recommandée pour des raisons de sécurité et sera prochainement désapprouvée.
Rubriques connexes