Atividade de Busca do Stripe
Introdução
Uma atividade de Busca do Stripe, utilizando sua conexão Stripe, pesquisa dados de objetos especificados no Stripe usando a Linguagem de Consulta de Busca do Stripe. Esta atividade é destinada a ser usada como uma fonte para fornecer dados em uma operação.
Criar uma atividade de Busca do Stripe
Uma instância de uma atividade de Busca do Stripe é criada a partir de uma conexão Stripe usando seu tipo de atividade Busca.
Para criar uma instância de uma atividade, arraste o tipo de atividade para a tela de design ou copie o tipo de atividade e cole-o na tela de design. Para detalhes, veja Criar uma instância de atividade ou ferramenta em Reutilização de componentes.
Uma atividade de Busca do Stripe existente pode ser editada a partir destes locais:
- A tela de design (veja Menu de ações do componente em Tela de design).
- A aba Componentes do painel do projeto (veja Menu de ações do componente em Aba Componentes do painel do projeto).
Configurar uma atividade de Busca do Stripe
Siga estas etapas para configurar uma atividade de Busca do Stripe:
-
Etapa 1: Insira um nome e selecione um objeto
Forneça um nome para a atividade e selecione um objeto. -
Etapa 2: Selecione um sub-objeto
Selecione um sub-objeto. -
Etapa 3: Selecione uma ação
Selecione uma ação. -
Etapa 4: Revise os esquemas de dados
Quaisquer esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos.
Passo 1: Insira um nome e selecione um objeto
Neste passo, forneça um nome para a atividade e selecione um objeto. Cada elemento da interface do usuário deste passo é descrito abaixo.
-
Nome: Insira um nome para identificar a atividade. O nome deve ser único para cada atividade de Busca do Stripe e não deve conter barras
/ou dois pontos:. -
Selecionar um Objeto: Esta seção exibe os objetos disponíveis no endpoint do Stripe.
-
Objeto Selecionado: Após um objeto ser selecionado, ele é listado aqui.
-
Buscar: Insira o valor de qualquer coluna na caixa de busca para filtrar a lista de objetos. A busca não diferencia maiúsculas de minúsculas. Se os objetos já estiverem exibidos na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar objetos do endpoint ao buscar, insira os critérios de busca e, em seguida, atualize, conforme descrito abaixo.
-
Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar objetos do endpoint do Stripe. Isso pode ser útil se objetos foram adicionados ao Stripe. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibidos na configuração.
-
Selecionando um Objeto: Dentro da tabela, clique em qualquer lugar de uma linha para selecionar um objeto. Apenas um objeto pode ser selecionado. As informações disponíveis para cada objeto são obtidas do endpoint do Stripe:
-
Nome: O nome do objeto.
-
Descrição: A descrição do objeto.
-
Dica
Se a tabela não for preenchida com objetos disponíveis, a conexão com o Stripe pode não ter sido bem-sucedida. Certifique-se de que você está conectado reabrindo a conexão e testando novamente as credenciais.
-
-
Continuar em Caso de Erro: Selecione para continuar a execução da atividade se um erro for encontrado para um conjunto de dados em uma solicitação em lote. Se algum erro for encontrado, ele será registrado no log de operações.
-
Salvar e Sair: Se habilitado, clique para salvar a configuração deste passo e fechar a configuração da atividade.
-
Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.
-
Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.
Etapa 2: Selecionar um subobjeto
Nesta etapa, selecione um subobjeto. Cada elemento da interface do usuário desta etapa é descrito abaixo.
-
Selecionar um Subobjeto: Esta seção exibe os subobjetos disponíveis no endpoint do Stripe.
-
Objeto Selecionado: O objeto selecionado na etapa anterior é listado aqui.
-
Selecionar um Subobjeto: Após um subobjeto ser selecionado, ele é listado aqui.
-
Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de subobjetos. A pesquisa não diferencia maiúsculas de minúsculas. Se os subobjetos já estiverem exibidos na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar subobjetos do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.
-
Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar subobjetos do endpoint do Stripe. Isso pode ser útil se subobjetos foram adicionados ao Stripe. Esta ação atualiza todos os metadados usados para construir a tabela de subobjetos exibida na configuração.
-
Selecionando um Subobjeto: Dentro da tabela, clique em qualquer lugar em uma linha para selecionar um subobjeto. Apenas um subobjeto pode ser selecionado. As informações disponíveis para cada subobjeto são obtidas do endpoint do Stripe:
-
Nome: O nome do subobjeto
-
Descrição: A descrição do subobjeto.
-
Dica
Se a tabela não for preenchida com subobjetos disponíveis, a conexão com o Stripe pode não ter sido bem-sucedida. Certifique-se de que você está conectado reabrindo a conexão e testando novamente as credenciais.
-
-
Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.
-
Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.
-
Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.
Etapa 3: Selecionar uma ação
Nesta etapa, selecione uma ação. Cada elemento da interface do usuário desta etapa é descrito abaixo.
-
Selecionar uma Ação: Esta seção exibe as ações disponíveis no endpoint do Stripe.
-
Sub-objeto Selecionado: O sub-objeto selecionado na etapa anterior é listado aqui.
-
Selecionar Ação: Após uma ação ser selecionada, ela é listada aqui.
-
Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de ações. A pesquisa não diferencia maiúsculas de minúsculas. Se as ações já estiverem exibidas na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar ações do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.
-
Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar ações do endpoint do Stripe. Isso pode ser útil se ações foram adicionadas ao Stripe. Esta ação atualiza todos os metadados usados para construir a tabela de ações exibida na configuração.
-
Selecionando uma Ação: Dentro da tabela, clique em qualquer lugar de uma linha para selecionar uma ação. Apenas uma ação pode ser selecionada. As informações disponíveis para cada ação são obtidas do endpoint do Stripe:
-
Nome: O nome da ação.
-
Descrição: A descrição da ação.
-
Dica
Se a tabela não for preenchida com ações disponíveis, a conexão com o Stripe pode não ter sido bem-sucedida. Certifique-se de que você está conectado reabrindo a conexão e retestando as credenciais.
-
-
Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.
-
Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.
-
Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.
Etapa 4: Revisar os esquemas de dados
Quaisquer esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos. Cada elemento da interface do usuário desta etapa é descrito abaixo.
-
Esquemas de Dados: Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante o mapeamento de transformação.
O conector Stripe utiliza a API Stripe. Consulte a documentação da API para obter informações sobre os nós e campos do esquema. Para mais informações sobre campos de consulta e seu uso, veja Linguagem de Consulta de Pesquisa.
-
Editar: Clique no ícone de edição acima do esquema de dados de resposta para entrar no modo de edição do esquema de resposta. O editor permite que você adicione, exclua e reorganize nós e campos e altere seus tipos de dados. Todas as ocorrências de nós e campos são definidas como
[0, 1]cardinalidade. As alterações feitas nos esquemas de dados devem ser aceitáveis para o endpoint e devem ser feitas apenas após consultar qualquer documentação disponível para o endpoint. Após fazer edições no esquema, uma data de última edição é exibida na parte superior do esquema aplicável para indicar que o esquema teve edições manuais. Atualizar os esquemas redefinirá os esquemas para suas estruturas padrão.Nota
Para retornar campos personalizados na resposta, você deve editar o esquema de resposta para incluir um nó
metadatacontendo pares chave-valor seguindo este padrão:"metadata": [{ "key": "any key", "value": "any value" }] -
Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas do endpoint do Stripe. Esta ação também regenera um esquema em outros locais do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.
-
Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.
-
Concluído: Clique para salvar a configuração de todas as etapas e fechar a configuração da atividade.
-
Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para confirmar que você deseja descartar as alterações.
Próximas etapas
Após configurar uma atividade de Busca do Stripe, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as configurações da operação, que incluem a capacidade de encadear operações que estão no mesmo ou em diferentes fluxos de trabalho.
As ações do menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para detalhes, veja o menu de ações da atividade em Conceitos básicos do conector.
Atividades de Busca do Stripe podem ser usadas como uma fonte com esses padrões de operação:
- Padrão de transformação
- Padrão de arquivo de dois alvos (como a primeira fonte apenas)
- Padrão de arquivo HTTP de dois alvos (como a primeira fonte apenas)
- Padrão de duas transformações (como a primeira ou segunda fonte)
Para usar a atividade com funções de script, escreva os dados em um local temporário e, em seguida, use esse local temporário na função de script.
Quando estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da operação.