Actualización, borrado y ejecución a través de la API
 |
En los ejemplos de este tema se supone que el usuario está familiarizado con la ejecución de HTTP POST en el entorno de desarrollo o aplicación Web.
|
Las siguientes reglas ayudan a comprender lo que se necesita en función del tipo de solicitud que se realiza.
|
Notas
|
URL de ejemplo
|
Acción HTTP
|
Tipo de contenido
|
|||
|---|---|---|---|---|---|---|
|
UPDATE
|
Las actualizaciones requieren la especificación de la parte de entidad también.
|
http://host/ThingWorx/Things/nombre_cosa
|
PUT
|
application/json o text/xml
|
||
|
DELETE
|
Los borrados requieren la especificación de la parte de entidad también.
|
http://host/ThingWorx/Things/nombre_cosa
|
DELETE
|
n/d
|
||
|
INVOKING SERVICES
|
La llamada a un servicio requiere especificar el URL completo, incluida la característica específica.
|
http://host/ThingWorx/Things/MyThing/Services/myService
|
POST
|
application/json
|
Ejecución de solicitudes HTTP
Al ejecutar solicitudes HTTP, utilice la codificación UTF-8 y especifique el valor de puerto opcional si procede.
 |
Se recomienda utilizar HTTPS en la producción o en cualquier momento en que la integridad de la red se vea cuestionada.
|
Control de códigos de respuesta HTTP
En la mayoría de los casos, se obtendrá contenido o el código de estado 200, que es lo correcto. En el caso de un error, se recibirá un mensaje de error.
Uso del contenido HTTP
Si se envía o recibe contenido HTTP (JSON, XML, HTML (solo para respuestas)), defina la cabecera del tipo de contenido de la solicitud en el valor adecuado según el contenido HTTP que se envía.
|
Métodos
|
|
|---|---|
|
GET
|
Se recupera un valor.
|
|
PUT
|
Se escribe un valor o se crean nuevas cosas o propiedades.
|
|
POST
|
Se ejecuta un servicio.
|
|
DELETE
|
Se borra una cosa o una propiedad.
|
|
Valores de cabecera de aceptación
|
|
|---|---|
|
JSON
|
application/json
|
|
XML
|
text/xml
|
|
HTML
|
text/html (u omita la cabecera de aceptación)
|
|
CSV
|
text/csv
|
|
Valores de cabecera de tipo de contenido
|
|
|---|---|
|
JSON
|
application/json
|
|
XML
|
text/xml
|
Metadatos
Es posible mostrar los metadatos de cualquier cosa específica, plantilla de cosa o definición que se cree yendo al siguiente URL en un explorador Web: NombreDeLaCosa/Metadata.
|
|
Para ver esta información, se debe mostrar como JSON.
|
Paso de la autenticación con la llamada a la API de REST
La práctica recomendada es utilizar una clave de aplicación. Genere la clave de aplicación en ThingWorx y, a continuación, se puede transferir con la llamada de REST en forma de cabecera HTTP.
Reemplace el valor de la cabecera por la clave de aplicación válida para la instancia de ThingWorx que desea conectar.
|
Clave de cabecera
|
Ejemplo de valor de cabecera
|
|---|---|
|
appKey
|
1x9256cf-9fe9-434e-adbe-9772c0c40261
|
La API de REST de ThingWorx soporta otros dos métodos de autenticación:
• La autenticación básica permite autenticar con el usuario y la contraseña.
• Transferencia de la clave de aplicación como parámetro de URL. Este método no se recomienda debido a los motivos de seguridad y quedará desfasado en el futuro.
Vínculos relacionados