IoT Platform:APIs de dados de produto

Pré-requisitos

Crie um produto e um dispositivo. Para mais informações, consulte Criar um produto e Criar um dispositivo.

Criar uma API de dados de produto

1. No console do IoT Platform, acesse a página Overview e clique no ID ou no alias da instância Enterprise Edition desejada.

2. No painel de navegação à esquerda, escolha Data Service > Data API.

3. Clique na aba Product Data API e, em seguida, clique em Create API.

4. No painel Create API, marque a caixa de seleção ao lado do produto desejado.

5. Clique em Apply.

   O sistema adiciona a API de dados de snapshot e a API de dados brutos do produto à lista de APIs de dados de produto.

   Parâmetro	API de dados de snapshot	API de dados brutos	API de dados de evento
   Nome da API	${productName} product snapshot data query	${productName} product raw data query	${productName} product event data query
   Caminho da API	/${productKey}/snapshot/data/get	/${productKey}/rawdata/get	/${productKey}/event/data/get

   ${productName} é o nome do produto e ${productKey} é o identificador exclusivo do produto.

Editar uma API de dados de produto

Para APIs de consulta de dados de snapshot e brutos, edite o nome da API, os parâmetros de solicitação e os parâmetros de resposta.

1. Na página Data API, clique na aba Product Data API.

2. Na lista de APIs, localize a API de consulta de dados de snapshot ou brutos do produto desejado e clique em Edit na coluna Actions.

3. No assistente Edit API, modifique as API Basic Information e clique em Next.

   Parâmetro	Descrição
   Nome da API	Altere o nome da API. O nome pode conter caracteres chineses, letras, dígitos, sublinhados (_) e hifens (-). O comprimento máximo é de 30 caracteres.
   Caminho da API	Este parâmetro não pode ser modificado.
   Tags da API	Insira o conteúdo da tag e pressione Enter para criá-la. As tags podem conter caracteres chineses, letras, dígitos, sublinhados (_) e hifens (-). Cada tag pode ter até 30 caracteres. Use tags para adicionar IDs personalizados às suas APIs e facilitar o gerenciamento. Importante É possível adicionar no máximo cinco tags a uma API.
   Descrição da API	Insira uma descrição para explicar os recursos da API e outras informações relevantes.
   Tipo de retorno	Formato dos dados retornados após a chamada da API. Este valor é fixo como JSON.

4. Na página Configure Parameters and Test, modifique os parâmetros de configuração e as configurações avançadas.

   Categoria	Item de configuração	Descrição
   Parâmetros de configuração	Parâmetros de solicitação	Clique em Add Parameter e selecione um Bound Field. Para o parâmetro adicionado, defina o operador, especifique se ele é obrigatório e forneça um valor de exemplo e uma descrição. Para excluir um parâmetro, clique no ícone de exclusão . Importante Se o tipo de parâmetro for numérico, o operador LIKE não é suportado.
   	Parâmetros de resposta	Por padrão, todos os campos retornáveis pela API estão selecionados. Especifique se um campo deve ser usado para ordenação e forneça um valor de exemplo e uma descrição. Para excluir um parâmetro, clique no ícone de exclusão . Após a exclusão, clique em Add Parameter para readicionar um campo vinculado como parâmetro de resposta. Também é possível marcar a caixa de seleção Select All Parameters à direita para reselecionar todos os campos como parâmetros de resposta. Nota Used for Sorting define que os dados consultados serão ordenados pelos valores deste campo em ordem crescente ou decrescente antes do retorno dos resultados.
   	Ordem de classificação	Selecione a ordem de classificação dos parâmetros. Ascending (padrão): Os parâmetros são classificados em ordem crescente. Descending: Os parâmetros são classificados em ordem decrescente.
   Configurações Avançadas	Ativar paginação para resultados	Escolha se deseja ativar a paginação para os resultados retornados. Disabled: É possível visualizar no máximo 100 resultados. Enabled: Permite visualizar todos os resultados em páginas. Ao ativar este recurso, o sistema adiciona automaticamente os seguintes parâmetros comuns: pageNum: O número da página. pageSize: A quantidade de resultados exibidos em cada página. O valor máximo é 100.
   	Configurações de erro de tempo limite	Se uma solicitação de chamada de API exceder 8000 milissegundos, o sistema retornará um erro de tempo limite. Este parâmetro não pode ser modificado.

5. Após concluir a configuração, na seção Test API, insira valores de teste para os parâmetros de solicitação e clique em Start Test.

   Visualize dados de amostra na aba Response Example ou veja os detalhes da solicitação na aba Request Details.

   Os parâmetros de solicitação incluem pageNum (INTEGER), pageSize (INTEGER), timestamp (BIGINT, obrigatório) e device_name (VARCHAR). Os dados formatados em JSON no exemplo de resposta contêm campos relacionados ao status de energia e luz dos dispositivos IoT, como date_time, ActivePower, LightVolt, PowerRatio, DrainVoltage, PowerConsumption, LightAdjustLevel, timestamp, device_name, iot_id, LightCurrent e LightStatus.

6. Clique em Publish.

   Importante

   • Certifique-se de que a API passou nos testes antes de publicá-la.

   • Se você clicar apenas em Save para uma API, o Status dela na página API Details será Unpublished.

   • Publique a API antes de chamá-la para consultar dados.

   Após a publicação da API, uma mensagem de sucesso é exibida com o API Name e o API Path. Clique em Copy para copiar o caminho. Exemplos de chamada para Java SDK, Node.js SDK e Python SDK estão disponíveis na parte inferior da página. Clique em View List para retornar à lista de APIs ou em Create Again para criar outra API.

Próximos passos

• Chame uma API de dados de produto para visualizar os dados brutos, de snapshot e de eventos de um dispositivo específico em um produto.

  Para exemplos de chamada, consulte:

  • Exemplo de chamada com Java SDK

  • Exemplo de chamada com Node.js SDK

• Verifique o uso da API na página API Details. Para mais informações, consulte Visualizar uma API.