IoT Platform:API de datos de producto

Requisitos previos

Debe haber creado un producto y un dispositivo. Para obtener más información, consulte Create a product y Create a device.

Crear una API de datos de producto

1. En la consola de IoT Platform, vaya a la página Overview y haga clic en el ID o alias de la instancia Enterprise Edition deseada.

2. En el panel de navegación izquierdo, seleccione Data Service > Data API.

3. Haga clic en la pestaña Product Data API y luego en Create API.

4. En el panel Create API, seleccione la casilla junto al producto deseado.

5. Haga clic en Apply.

   La API de datos de instantáneas y la API de datos sin procesar del producto se agregan a la lista de API de datos de producto.

   Parámetro	API de datos de instantáneas	API de datos sin procesar	API de datos de eventos
   Nombre de la API	${productName} product snapshot data query	${productName} product raw data query	${productName} product event data query
   Ruta de la API	/${productKey}/snapshot/data/get	/${productKey}/rawdata/get	/${productKey}/event/data/get

   ${productName} es el nombre del producto y ${productKey} es el identificador único del producto.

Editar una API de datos de producto

Para las API de consulta de datos de instantáneas y sin procesar, puede editar el nombre de la API, los parámetros de solicitud y los parámetros de respuesta.

1. En la página Data API, haga clic en la pestaña Product Data API.

2. En la lista de API, busque la API de consulta de datos de instantáneas o sin procesar del producto deseado y haga clic en Edit en la columna Actions.

3. En el asistente Edit API, modifique la API Basic Information y haga clic en Next.

   Parámetro	Descripción
   Nombre de la API	Cambie el nombre de la API. El nombre puede contener caracteres chinos, letras, dígitos, guiones bajos (_) y guiones (-). La longitud máxima es de 30 caracteres.
   Ruta de la API	Este parámetro no se puede modificar.
   Etiquetas de la API	Introduzca el contenido de la etiqueta y presione Enter para crearla. Las etiquetas pueden contener caracteres chinos, letras, dígitos, guiones bajos (_) y guiones (-). Cada etiqueta puede tener hasta 30 caracteres de longitud. Utilice etiquetas para agregar identificadores personalizados a sus API y facilitar su gestión. Importante Puede agregar un máximo de cinco etiquetas a una API.
   Descripción de la API	Introduzca una descripción para la API que explique sus funciones y otra información relevante.
   Tipo de retorno	El formato de los datos devueltos tras invocar la API. Este valor es fijo: JSON.

4. En la página Configure Parameters and Test, modifique los parámetros de configuración y la configuración avanzada.

   Categoría	Elemento de configuración	Descripción
   Parámetros de configuración	Parámetros de solicitud	Haga clic en Add Parameter y seleccione un Bound Field. Para el parámetro agregado, puede establecer el operador, especificar si es obligatorio y proporcionar un valor de ejemplo y una descripción. Para eliminar un parámetro, haga clic en el icono de eliminación . Importante Si el tipo de parámetro es numérico, no se admite el operador LIKE.
   	Parámetros de respuesta	De forma predeterminada, se seleccionan todos los campos que la API puede devolver. Puede especificar si un campo se usa para ordenar y proporcionar un valor de ejemplo y una descripción. Para eliminar un parámetro, haga clic en el icono de eliminación . Después de eliminar un parámetro, puede hacer clic en Add Parameter para volver a agregar un campo vinculado como parámetro de respuesta. También puede seleccionar la casilla Select All Parameters a la derecha para volver a seleccionar todos los campos como parámetros de respuesta. Nota Used for Sorting indica que los datos consultados se ordenan por los valores de este campo en orden ascendente o descendente antes de devolver los resultados de la consulta.
   	Orden de clasificación	Seleccione el orden en el que se clasificarán los parámetros. Ascending (predeterminado): Los parámetros se ordenan de forma ascendente. Descending: Los parámetros se ordenan de forma descendente.
   Configuración avanzada	Habilitar paginación de resultados	Seleccione si desea habilitar la paginación para los resultados devueltos. Disabled: Puede ver un máximo de 100 resultados. Enabled: Puede ver todos los resultados por páginas. Si habilita esta función, se agregan automáticamente los siguientes parámetros comunes: pageNum: El número de página. pageSize: El número de resultados que se mostrarán en cada página. El valor máximo es 100.
   	Configuración de error de tiempo de espera	Si una solicitud de llamada a la API supera los 8000 milisegundos, se devuelve un error de tiempo de espera. Este parámetro no se puede modificar.

5. Una vez completada la configuración, en la sección Test API, introduzca valores de prueba para los parámetros de solicitud y haga clic en Start Test.

   Puede ver datos de ejemplo en la pestaña Response Example o consultar los detalles de la solicitud en la pestaña Request Details.

   Los parámetros de solicitud incluyen pageNum (INTEGER), pageSize (INTEGER), timestamp (BIGINT, obligatorio) y device_name (VARCHAR). Los datos con formato JSON en el ejemplo de respuesta contienen campos relacionados con el estado de energía y luz de los dispositivos IoT, como date_time, ActivePower, LightVolt, PowerRatio, DrainVoltage, PowerConsumption, LightAdjustLevel, timestamp, device_name, iot_id, LightCurrent y LightStatus.

6. Haga clic en Publish.

   Importante

   • Asegúrese de que la API pase la prueba antes de publicarla.

   • Si solo hace clic en Save para una API, su Status en la página API Details será Unpublished.

   • Debe publicar una API antes de poder invocarla para consultar datos.

   Después de publicar la API, aparece un mensaje de éxito y se muestran el Nombre de la API y la Ruta de la API. Puede hacer clic en Copy para copiar la ruta. En la parte inferior de la página se proporcionan ejemplos de llamada para los SDK de Java, Node.js y Python. Puede hacer clic en View List para volver a la lista de API o en Create Again para crear otra API.

Siguientes pasos

• Invoque una API de datos de producto para ver los datos sin procesar, de instantáneas y de eventos de un dispositivo específico dentro de un producto.

  Para ver ejemplos de llamadas, consulte:

  • Java SDK call example

  • Node.js SDK call example

• Consulte el uso de la API en la página API Details. Para obtener más información, consulte View an API.