DataWorks:Primeiros passos com o DataService Studio

Desenvolvimento de API

Data Push

O Data Push permite enviar dados proativamente para um público-alvo de forma programada. Crie uma tarefa de Data Push para personalizar e orquestrar conteúdos, como rich text e tabelas, a partir de várias fontes de dados. Defina a frequência de envio e configure destinatários e canais conforme suas necessidades de negócios. Para mais informações, consulte Data Push.

Pré-requisitos

• O API Gateway deve estar ativado. Para mais informações, consulte Ativar o API Gateway.

• Uma fonte de dados de destino deve estar criada. Este tópico usa uma fonte de dados MySQL como exemplo. Essa fonte fornece os dados de entrada necessários para gerar a API. Para mais detalhes, consulte Configurar uma fonte de dados.

• Um grupo de recursos Serverless deve estar criado e com cota configurada para o DataService Studio. Para saber mais, consulte Configurar uma cota para o DataService Studio em um grupo de recursos Serverless.

Etapa 1: Criar fonte de dados e configurar rede

Antes de criar uma API, adicione seu banco de dados ou data warehouse como uma fonte de dados do DataWorks e garanta que o grupo de recursos do DataService Studio possa se conectar a ela. Isso permite que o DataWorks acesse a fonte de dados quando uma API for chamada.

Durante o desenvolvimento, o DataService Studio recupera o esquema da tabela dessa fonte para ajudar na configuração dos parâmetros de solicitação e resposta. No momento da chamada, ele executa consultas na fonte de dados. Para visualizar as fontes suportadas, consulte Lista de fontes de dados para o DataService Studio.

Este exemplo mostra como criar uma fonte de dados MySQL chamada rds_workshop_log e testar sua conectividade com um grupo de recursos Serverless.

1. Acesse o console do DataWorks, selecione o workspace desejado e clique em Go to Management Center.

2. No painel de navegação à esquerda, clique em Data Sources.

3. Crie uma fonte de dados e teste sua conectividade de rede.

   1. Clique em Add Connection e selecione um tipo de fonte de dados.

      Este exemplo utiliza MySQL.

   2. Configure as informações da fonte de dados.

      Defina os parâmetros conforme solicitado na página. Para mais informações, consulte Configurar uma fonte de dados MySQL.

   3. Selecione um grupo de recursos Serverless e teste a conectividade entre o grupo de recursos e a fonte de dados.

      Nota

      • Se você tiver tarefas de alta concorrência que não podem ser executadas fora do horário de pico, use recursos dedicados para garantir chamadas de API de alta concorrência e alta frequência. Recomendamos adquirir e usar um grupo de recursos Serverless do DataWorks.

      • Ao usar um grupo de recursos Serverless, é necessário configurar uma cota para o DataService Studio no grupo de recursos Serverless.

      • Se o teste de conectividade falhar, verifique sua configuração seguindo as instruções em Conexões de rede e listas de permissões.

   4. Clique em Complete para criar a fonte de dados.

Etapa 2: Criar um grupo de API

O DataService Studio atende sistemas externos por meio do API Gateway. No API Gateway, um grupo é a unidade de gerenciamento para APIs e está associado ao nome de domínio do endereço de chamada. Crie um grupo de API no API Gateway antes de criar uma API no DataService Studio.

1. Acesse o console do API Gateway. Na página Group Management, clique em Create Group.

2. Insira as informações do grupo e conclua a criação. Este exemplo cria um grupo chamado Workshop.

Etapa 3: Criar um processo de negócios

Processos de negócios organizam o desenvolvimento de APIs em torno de unidades de negócio e gerenciam arquivos como APIs e funções. Crie um processo de negócios antes de criar uma API.

1. Faça login no console do DataWorks. Na região alvo, clique em Data Analysis and Service > DataService Studio no painel de navegação à esquerda. Selecione um workspace na lista suspensa e clique em Go to DataService Studio.

2. Crie um processo de negócios.

   Na página Data Services > Service Development, crie um processo de negócios de uma das seguintes formas:

   • Método 1: Clique em no ícone e selecione Create Workflow.

   • Método 2: No painel de navegação à esquerda, clique em com o botão direito na pasta Workflow e selecione Create Workflow.

3. Configure os parâmetros do processo de negócios.

   Configuração	Descrição
   Workflow Name	Insira um nome personalizado baseado no seu cenário de negócios. Este exemplo cria um processo de negócios chamado DataService.
   API grouping	Selecione um grupo de API para gerenciar suas APIs. Este exemplo usa o grupo Workshop criado na Etapa 2. Nota Um grupo de API é uma coleção de APIs para um recurso ou cenário específico e a menor unidade de gerenciamento de API no API Gateway. Se precisar criar um novo grupo, consulte Etapa 2: Criar um grupo de API.

4. Clique em Determine para criar o processo de negócios.

   Após a criação, visualize o processo de negócios no painel de navegação à esquerda da página do DataService Studio.

Etapa 4: Gerar uma API

Depois de criar um processo de negócios, crie APIs dentro dele.

1. Gere uma API.

   Na página Data Services > Service Development, gere uma API de uma das seguintes maneiras:

   • Método 1: Clique em no ícone e escolha Create API > Generate API.

   • Método 2: No painel de navegação à esquerda, clique em com o botão direito no processo de negócios de destino e escolha Create > API > Generate API.

3. Defina as propriedades da API.

   Na caixa de diálogo Generate API, configure as informações da API. A tabela a seguir descreve os principais parâmetros.

   Item de Configuração	Descrição
   Location	O diretório dentro do processo de negócios onde a API será armazenada. Importante Recomendamos selecionar primeiro a pasta de destino. Caso não consiga selecionar uma, crie um processo de negócios antes.
   API Mode	Selecione o modo para criar a API. Escolha entre a interface visual sem código ou o editor de código. Codeless UI: Configure rapidamente uma API de dados sem escrever código. Code editor: Suporta recursos avançados como junção de tabelas, consultas complexas e funções de agregação. Permite escrever consultas SQL personalizadas para a API, atendendo a requisitos avançados de consulta. Este tópico usa a interface sem código como exemplo. Para detalhes sobre ambos os modos, consulte Visão geral da geração de API.
   API Name	Insira um nome personalizado para a API. Este tópico usa rpt_user_info_all_d como exemplo.
   APIPath	O caminho de armazenamento da API. Trata-se da URI da solicitação relativa ao host do serviço. Este caminho é usado para construir o endereço de chamada da API. Este tópico usa /user como exemplo.
   Protocol	HTTP e HTTPS são suportados. Para chamar a API via HTTPS, vincule um nome de domínio independente e carregue um certificado SSL no console do API Gateway após publicar a API no gateway. Para mais informações, consulte Suporte para HTTPS.
   Request Method	GET e POST são suportados. Nota Se selecionar GET como método de solicitação, só será possível definir os Request Parameters com Parameter Position como QUERY. Se selecionar POST como método de solicitação, defina os Request Parameters com Parameter Position como QUERY ou BODY.
   Response Type	Apenas JSON é suportado.
   Visible Scope	A visibilidade da API após a criação. As opções são Work space e Private. Work space: A API fica visível para todos os membros do workspace atual. Private: A API fica visível apenas para o proprietário. Não há suporte para autorização. Este exemplo define o escopo de visibilidade como Work space.

4. Configure os parâmetros da API.

   Na página de edição da API, configure os seguintes parâmetros.

   1. Selecione a fonte de dados para a API.

      Na área Table, selecione a tabela da fonte de dados para gerar a API.

      Parâmetro	Descrição
      Data Source Type	Selecione o tipo de fonte de dados a partir do qual criar a API. Este tópico usa MySQL como exemplo.
      Data Source Name	Selecione a fonte de dados específica do tipo escolhido para gerar a API. Este exemplo usa a fonte de dados rds_workshop_log criada na Etapa 1: Criar fonte de dados e configurar conectividade de rede.
      Data Source Environment	Workspaces no modo padrão permitem acesso a fontes de dados no ambiente de desenvolvimento ou produção. Para mais informações sobre as diferenças entre os dois ambientes, consulte Diferenças entre modos de workspace. Este exemplo seleciona o Production Environment.
      Data Table Name	Selecione a tabela de dados na fonte de dados a partir da qual gerar a API. Este tópico usa a tabela rpt_user_info_all_d na fonte de dados rds_workshop_log como exemplo.

   2. Defina os parâmetros de solicitação e resposta.

      Após selecionar uma tabela, seus campos aparecem na área Select Parameters. Em seguida, escolha os campos para usar como parâmetros de solicitação e resposta. Para ordenar os campos, adicione-os à área Sort field e ajuste a ordem.

      Neste exemplo, o parâmetro de solicitação é uid, e os parâmetros de resposta são todos os campos da tabela.

      Nota

      No painel de navegação à direita, clique em Request Parameters ou Response Parameters para modificar configurações de parâmetros, como tipo de campo, valor de amostra e valor padrão. Configure essas definições conforme suas necessidades reais.

5. Configure o grupo de recursos da API.

   Na página de edição da API, clique em Resource Group for DataService Studio à direita para configurar o grupo de recursos. Como o grupo de recursos público para o DataService Studio está sendo descontinuado, novas APIs devem usar um grupo de recursos de serviço exclusivo. Selecione um grupo de recursos Serverless (recomendado) com cota configurada para o DataService Studio, ou um grupo de recursos exclusivo para o DataService Studio.

Etapa 5: Testar a API

Teste a API antes de publicá-la. Após gerar a API, clique em Test no canto superior direito da página de edição da API para verificar se a solicitação e a resposta estão conforme o esperado. Este exemplo define o valor do parâmetro de solicitação uid como 0016359810821 para testar o resultado. Para mais informações sobre testes, consulte Testar uma API.

Etapa 6: Publicar a API

Uma API aprovada nos testes deve ser publicada antes que outros serviços possam chamá-la. No canto superior direito da página de edição da API, clique em Submission e selecione a versão a ser publicada. Para mais informações, consulte Testar, publicar e gerenciar versões da API.

Etapa 7: Chamar a API

Os seguintes métodos de autenticação são suportados para chamar APIs:

• Simple Authentication: Baixa segurança. Adequado para cenários como relatórios e painéis de dados.

• Encrypted Signature Authentication: Alta segurança. Indicado para cenários de desenvolvimento de aplicações.

1. Na barra de menu superior do DataService Studio, clique em Service Management para acessar a página de gerenciamento de serviços.

2. No painel de navegação à esquerda, selecione Call APIs.

   As APIs publicadas ficam disponíveis no API Gateway. Chame a API usando um SDK do API Gateway. Para mais informações, consulte Exemplos de chamada de API a partir de um cliente.

Etapa 8: Visualizar e gerenciar APIs

Na página Service Management, visualize as APIs publicadas e execute operações como cancelar publicação, autorização e visualização de detalhes de chamadas.

Área	Descrição
Gerenciamento de API	Na página Service Management > Manage APIs, visualize APIs atualmente publicadas, APIs que você tem autorização para usar e APIs que você autorizou para outros. Também é possível executar operações como Unpublish, Authorization e Test em APIs para as quais você tem permissões.
Medição de API	Na página Service Management > API Statistics, realize as seguintes operações: Statistics Dashboard: Visualize um resumo das informações de chamadas de API, incluindo contagem total de APIs, distribuição de códigos de status, distribuição de códigos de erro, medição geral e alocação de grupos de recursos. Statistics Details: Fornece vários gráficos e estatísticas. Visualize gráficos de monitoramento para uma única API, incluindo códigos de status do API Gateway, códigos de erro do DataService Studio, contagens de solicitações de apps, largura de banda de tráfego e tempo médio de resposta. Log Analysis: Analise solicitações de chamada usando o recurso de análise de log. Para solicitações anormais, a análise inteligente ajuda a localizar o problema e fornece diagnóstico e sugestões.