IoT Platform:API de serviço personalizada

Pré-requisitos

Crie métricas e tabelas de armazenamento para suas fontes de dados. Para mais informações, consulte Visão geral de métricas e Tabelas de armazenamento personalizadas.

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

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

3. Na página Data API, clique em custom service API e, em seguida, clique em Create API.

4. No assistente Create API, configure as opções na seção API basic information e clique em Next.

   Parâmetro	Descrição
   Nome da API	Insira um nome para a API. O nome pode conter caracteres chineses, letras, dígitos, sublinhados (_) e hifens (-), com até 30 caracteres.
   Caminho da API	Insira o caminho da API. Ele funciona como identificador exclusivo de recurso na instância. Ao chamar a API, o valor do parâmetro de solicitação apiPath deve corresponder a este caminho. O caminho deve começar com barra (/) e pode conter letras, dígitos, sublinhados (_) e barras (/). O comprimento máximo é de 128 caracteres. Exemplo: /pk/temperatureMax. Importante Não é possível alterar o caminho da API após a publicação.
   Tag da API	Insira o conteúdo da tag e pressione Enter. Uma tag pode conter caracteres chineses, letras, dígitos, sublinhados (_) e hifens (-), com até 30 caracteres. Use tags como identificadores personalizados para facilitar o gerenciamento das APIs. Importante É permitido adicionar no máximo cinco tags por API.
   Descrição da API	Insira uma descrição para a API, como finalidade e capacidades.
   Formato de resposta	O formato dos dados de resposta é fixo em JSON.

5. Na página Configure and test parameters, preencha as seguintes configurações.

   Categoria	Parâmetro	Descrição
   Fonte de dados	Métrica	Selecione um metric field e um dataset específicos. Um dataset representa uma organização específica de objetos dentro de um campo de métrica, como um produto específico no campo de produtos ou um dispositivo específico no campo de dispositivos. Para mais informações sobre métricas, consulte O que é uma métrica?.
   	Tabela de armazenamento	Selecione uma tabela de armazenamento personalizada gerada por tarefa de análise de dados ou SQL. Para mais detalhes, consulte Tabela de armazenamento frio.
   Configurar parâmetros	Conjunto de dados	Esta opção aparece somente após selecionar Metric como data source e especificar um metric field e um dataset. Clique em Preview Data para acessar a página de detalhes da fonte de dados selecionada.
   	Escopo dos dados	Esta configuração é exibida apenas se você selecionar Metric como data source. Defina o escopo de dados para a API: derived metric: Dados obtidos de métricas brutas, definições originais e definições derivadas por meio de cálculos agregados, como soma e média. derived definition: Métrica derivada de uma definição original e aplicada a subentidades. Para saber mais sobre métricas e definições derivadas, consulte Tipos de métricas.
   	Parâmetros de solicitação	Clique em Add Parameter para adicionar métricas da fonte de dados selecionada como parâmetros de solicitação da API. Há suporte apenas para campos de sistema e campos de chave primária de tabela de armazenamento personalizada. Para cada parâmetro, configure o campo de vinculação, nome, tipo, operador, obrigatoriedade, valor de exemplo e descrição. Importante Se o tipo do parâmetro for numérico, não há suporte para o operador LIKE.
   	Parâmetros de resposta	Clique em Add Parameter para adicionar métricas da fonte de dados selecionada como parâmetros de resposta da API. Em cada parâmetro, configure a prioridade, campo de vinculação, nome, tipo, uso para ordenação, valor de exemplo e descrição. Marque a caixa de seleção Select All Parameters à direita para incluir todos os campos da tabela na resposta da API. Nota Ordena os resultados por este campo em ordem crescente ou decrescente. Cada métrica pode ser configurada como apenas um parâmetro de resposta.
   	Ordem de classificação	Escolha a ordem de classificação dos parâmetros. Ascending (padrão): Os parâmetros são organizados em ordem crescente. Descending: Os parâmetros são organizados em ordem decrescente.
   Configurações Avançadas	Ativar resposta paginada	Define se a paginação será ativada para a resposta. Disabled: Retorna no máximo 100 resultados. Enabled: Retorna todos os resultados em páginas. Ao ativar este recurso, os seguintes parâmetros comuns são adicionados automaticamente: pageNum: O número da página. pageSize: O tamanho da página. O valor máximo é 100.
   	Configuração de erro de tempo limite	Se uma chamada de API exceder 8 segundos, o sistema retornará um erro de tempo limite. Não é possível modificar esta configuração.

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

   Visualize os dados de amostra na aba Response Example ou clique em Request Details para ver informações específicas da solicitação. Se o teste for bem-sucedido, a aba Response Example exibirá a resposta JSON, incluindo campos como errCode:0 e errMsg:"success". Uma mensagem de Test succeeded e a duração da chamada da API aparecerão na parte inferior.

6. Clique em Publish.

   Importante

   • Antes de publicar uma API, certifique-se de que ela passou no teste.

   • Se você clicar apenas em Save, a API será salva com status offline.

   • Para uma API com configurações incompletas, clique em Edit para finalizar a configuração e depois publicá-la.

   • Somente APIs offline podem ser excluídas.

   Na página Published successfully, clique em Create Another para criar mais APIs personalizadas ou em View in List para visualizar a API na lista.

Próximos passos

Depois de criar uma API de serviço personalizada, chame-a para recuperar dados. Para instruções, consulte Gerenciar e usar APIs.

Para exemplos de chamada, consulte:

• Exemplo de chamada com SDK Java

• Exemplo de chamada com SDK Node.js