Stripe

O conetor do Stripe permite-lhe realizar operações de inserção, eliminação, atualização e leitura no conjunto de dados do Stripe.

Antes de começar

Antes de usar o conector do Stripe, conclua as seguintes tarefas:

  • No seu projeto do Google Cloud:
    • Certifique-se de que a conetividade de rede está configurada. Para obter informações sobre padrões de rede, consulte o artigo Conetividade de rede.
    • Conceda a função IAM roles/connectors.admin ao utilizador que está a configurar o conetor.
    • Conceda as seguintes funções de IAM à conta de serviço que quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta Google destinada a representar um utilizador não humano que precisa de autenticação e autorização para aceder a dados nas APIs Google. Se não tiver uma conta de serviço, tem de criar uma. O conector e a conta de serviço têm de pertencer ao mesmo projeto. Para mais informações, consulte Criar uma conta de serviço.

    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (API Connectors)

      Para saber como ativar serviços, consulte o artigo Ativar serviços.

    Se estes serviços ou autorizações não tiverem sido ativados anteriormente para o seu projeto, é-lhe pedido que os ative quando configurar o conector.

  • Para obter informações sobre como criar uma conta do Stripe, consulte o artigo Crie uma conta do Stripe ou Crie uma conta e saiba como começar a usar o Stripe.

Configure o conetor

Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

  1. Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.

    Aceda à página Ligações

  2. Clique em + Criar novo para abrir a página Criar associação.
  3. Na secção Localização, escolha a localização para a ligação.
    1. Região: selecione uma localização na lista pendente.

      Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.

    2. Clicar em Seguinte.
  4. Na secção Detalhes da associação, conclua o seguinte:
    1. Conetor: selecione Stripe na lista pendente de conetores disponíveis.
    2. Versão do conetor: selecione a versão do conetor na lista pendente de versões disponíveis.
    3. No campo Nome da ligação, introduza um nome para a instância de ligação.

      Os nomes das associações têm de cumprir os seguintes critérios:

      • Os nomes das associações podem usar letras, números ou hífenes.
      • As letras têm de ser minúsculas.
      • Os nomes das associações têm de começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das associações não podem exceder 49 carateres.
    4. Opcionalmente, introduza uma Descrição para a instância de associação.
    5. Opcionalmente, ative o Registo na nuvem e, em seguida, selecione um nível de registo. Por predefinição, o nível do registo está definido como Error.
    6. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
    7. Opcionalmente, configure as definições do nó de associação:

      • Número mínimo de nós: introduza o número mínimo de nós de ligação.
      • Número máximo de nós: introduza o número máximo de nós de ligação.

      Um nó é uma unidade (ou uma réplica) de uma ligação que processa transações. São necessários mais nós para processar mais transações para uma ligação e, inversamente, são necessários menos nós para processar menos transações. Para compreender como os nós afetam os preços dos conectores, consulte o artigo Preços dos nós de ligação. Se não introduzir valores, por predefinição, os nós mínimos são definidos como 2 (para uma melhor disponibilidade) e os nós máximos são definidos como 50.

    8. Account Id: o ID da conta que quer usar.
    9. (Opcional) Na secção Definições avançadas, selecione a caixa de verificação Usar proxy para configurar um servidor proxy para a ligação e configurar os seguintes valores:
      • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Os seguintes tipos de autenticação são suportados:
        • Básica: autenticação HTTP básica.
        • Resumo: autenticação HTTP de resumo.
      • Utilizador do proxy: um nome de utilizador a ser usado para autenticação com o servidor proxy.
      • Palavra-passe do proxy: o segredo do Secret Manager da palavra-passe do utilizador.
      • Tipo de SSL do proxy: o tipo de SSL a usar quando se liga ao servidor proxy. Os seguintes tipos de autenticação são suportados:
        • Automático: predefinição. Se o URL for um URL HTTPS, é usada a opção Túnel. Se o URL for um URL HTTP, é usada a opção NUNCA.
        • Sempre: a ligação está sempre ativada com SSL.
        • Nunca: a ligação não tem o SSL ativado.
        • Túnel: a ligação é feita através de um proxy de túnel. O servidor proxy abre uma ligação ao anfitrião remoto e o tráfego flui em ambas as direções através do proxy.
      • Na secção Servidor proxy, introduza os detalhes do servidor proxy.
        1. Clique em + Adicionar destino.
        2. Selecione um Tipo de destino.
          • Endereço do anfitrião: especifique o nome do anfitrião ou o endereço IP do destino.

            Se quiser estabelecer uma ligação privada ao seu sistema de back-end, faça o seguinte:

    10. Opcionalmente, clique em + ADICIONAR ETIQUETA para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
    11. Clicar em Seguinte.
  5. Na secção Autenticação, introduza os detalhes de autenticação.

    A ligação do Stripe suporta a autenticação do tipo API Key. Selecione o segredo do Secret Manager para a chave da API no menu pendente Chave da API e, de seguida, selecione a versão do segredo correspondente.

  6. Clicar em Seguinte.
  7. Rever: reveja os detalhes da ligação e da autenticação.
  8. Clique em Criar.

Exemplos de configuração de ligação

Esta secção apresenta os valores de exemplo para os vários campos que configura quando cria a associação do Stripe.

Tipo de ligação da chave da API em direto

Nome do campo Detalhes
Localização us-central1
Conetor Stripe
Versão do conetor 1
Nome da ligação stripe-connection
Ative o Cloud Logging Sim
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
ID da conta ACCOUNT_ID
Nível de verbosidade 5
Número mínimo de nós 2
Número máximo de nós 50
Chave da API Live LIVE_API_KEY
Versão do Secret 1

Para informações sobre a chave da API em direto, consulte o artigo Chave da API em direto.

Entidades, operações e ações

Todos os conetores de integração oferecem uma camada de abstração para os objetos da aplicação ligada. Só pode aceder aos objetos de uma aplicação através desta abstração. A abstração é exposta como entidades, operações e ações.

  • Entidade: pode considerar uma entidade como um objeto ou uma coleção de propriedades na aplicação ou no serviço associado. A definição de uma entidade difere de um conetor para um conetor. Por exemplo, num conetor de base de dados, as tabelas são as entidades. Num conetor de servidor de ficheiros, as pastas são as entidades. Num conetor de sistema de mensagens, as filas são as entidades.

    No entanto, é possível que um conector não suporte ou não tenha entidades, caso em que a lista Entities estará vazia.

  • Operação: uma operação é a atividade que pode realizar numa entidade. Pode realizar qualquer uma das seguintes operações numa entidade:

    Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para a entidade. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa de conectores. No entanto, se um conector não suportar nenhuma das operações de entidades, essas operações não suportadas não são apresentadas na lista Operations.

  • Ação: uma ação é uma função de primeira classe que é disponibilizada à integração através da interface do conetor. Uma ação permite-lhe fazer alterações a uma ou mais entidades e varia de conetor para conetor. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro de saída. No entanto, é possível que um conector não suporte nenhuma ação, caso em que a lista Actions está vazia.

Limitações do sistema

O conector do Stripe pode processar 6 transações por segundo, por , e limita todas as transações que excedam este limite. Por predefinição, os Integration Connectors atribuem 2 nós (para uma melhor disponibilidade) a uma ligação.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Use a ligação do Stripe numa integração

Depois de criar a ligação, esta fica disponível no Apigee Integration e no Application Integration. Pode usar a ligação numa integração através da tarefa Conectores.

  • Para compreender como criar e usar a tarefa Connectors no Apigee Integration, consulte o artigo Tarefa Connectors.
  • Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

Ações

Esta secção apresenta as ações suportadas pelo conetor. Para compreender como configurar as ações, consulte os exemplos de ações.

Ação ConfirmPaymentIntent

Esta ação confirma a intenção de pagamento.

Introduza os parâmetros da ação ConfirmPaymentIntent

Nome do parâmetro Tipo de dados Obrigatória Descrição
PaymentIntentId String Sim O ID do PaymentIntent.

Por exemplo, para saber como configurar a ação ConfirmPaymentIntent, consulte os exemplos de ações.

Ação CapturePaymentIntent

Esta ação capta a intenção de pagamento.

Parâmetros de entrada da ação CapturePaymentIntent

Nome do parâmetro Tipo de dados Obrigatória Descrição
PaymentIntentId String Sim O ID do PaymentIntent.

Por exemplo, para saber como configurar a ação ConfirmPaymentIntent, consulte os exemplos de ações.

Ação CancelPaymentIntent

Esta ação cancela a intenção de pagamento.

Introduza os parâmetros da ação CancelPaymentIntent

Nome do parâmetro Tipo de dados Obrigatória Descrição
PaymentIntentId String Sim O ID do PaymentIntent.

Por exemplo, para saber como configurar a ação CancelPaymentIntent, consulte os exemplos de ações.

Ação AttachPaymentMethodToCustomer

Esta ação anexa um objeto PaymentMethod a um cliente.

Parâmetros de entrada da ação AttachPaymentMethodToCustomer

Nome do parâmetro Tipo de dados Obrigatória Descrição
PaymentMethodId String Sim O ID do método de pagamento.
CustomerId String Sim O ID do cliente ao qual o PaymentMethod deve ser anexado.

Por exemplo, para saber como configurar a ação AttachPaymentMethodToCustomer, consulte os exemplos de ações.

Ação DetachPaymentMethodFromCustomer

Esta ação desassocia um objeto PaymentMethod de um cliente. Depois de desassociar um PaymentMethod, não pode voltar a associá-lo ao cliente.

Parâmetros de entrada da ação DetachPaymentMethodFromCustomer

Nome do parâmetro Tipo de dados Obrigatória Descrição
PaymentMethodId String Sim O ID do método de pagamento.

Por exemplo, para saber como configurar a ação DetachPaymentMethodFromCustomer, consulte os exemplos de ações.

Ação FinalizeInvoice

Esta ação finaliza a fatura em rascunho.

Introduza os parâmetros da ação Finalize Invoice

Nome do parâmetro Tipo de dados Obrigatória Descrição
InvoiceId String Sim O ID do QuoInvoicete.

Por exemplo, para saber como configurar a ação FinalizeInvoice, consulte os exemplos de ações.

Ação FinalizeQuote

Esta ação finaliza a estimativa em rascunho.

Introduza os parâmetros da ação FinalizeQuote

Nome do parâmetro Tipo de dados Obrigatória Descrição
SouQuoteIdrcePath String Sim O ID da cotação.

Por exemplo, para saber como configurar a ação FinalizeQuote, consulte os exemplos de ações.

Ação AcceptQuote

Esta ação aceita a estimativa do custo e gera uma fatura para a estimativa do custo aceite.

Parâmetros de entrada da ação AcceptQuote

Nome do parâmetro Tipo de dados Obrigatória Descrição
QuoteId String Sim O ID da cotação.

Por exemplo, para saber como configurar a ação AcceptQuote, consulte os exemplos de ações.

Ação CancelQuote

Esta ação cancela o pedido de orçamento em rascunho.

Introduza os parâmetros da ação CancelQuote

Nome do parâmetro Tipo de dados Obrigatória Descrição
QuoteId String Sim O ID da cotação.

Por exemplo, para saber como configurar a ação CancelQuote, consulte os exemplos de ações.

Exemplos de ações

Esta secção descreve como realizar algumas das ações neste conector.

Exemplo: confirme a intenção de pagamento

Este exemplo mostra como confirmar a intenção do pagamento especificado.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação ConfirmPaymentIntent e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
    "ReturnUrl": "http://google.com/",
    "PaymentIntentId": "pi_3OggwFANHgX3SHp71AVrNtT3"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta da tarefa ConfirmPaymentIntentconnectorOutputPayload terá um valor semelhante ao seguinte:

    [{
    "Success": "true",
    "id": "pi_3OggwFANHgX3SHp71AVrNtT3",
    "object": "payment_intent",
    "amount": "33000",
    "amount_capturable": "0",
    "amount_received": "33000",
    "canceled_at": null,
    "cancellation_reason": null,
    "capture_method": "automatic",
    "client_secret": "pi_3OggwFANHgX3SHp71AVrNtT3_secret_YEfjrYL5uHQZrGCx66cJbedlA",
    "confirmation_method": "automatic",
    "created": "1707196279",
    "currency": "usd",
    "invoice": null,
    "last_payment_error": null,
    "latest_charge": "ch_3OggwFANHgX3SHp71uYScRAw",
    "level3": null,
    "livemode": "false",
    "next_action": null,
    "on_behalf_of": null,
    "payment_method": "pm_1Oggu6ANHgX3SHp7zaRNKNVL",
    "payment_method_configuration_details": null,
    "payment_method_options.card.installments": null,
    "review": null,
    "setup_future_usage": null,
    "statement_descriptor_suffix": null,
    "status": "succeeded",
    "transfer_data": null,
    "transfer_group": null
    }]

Exemplo: captar a intenção de pagamento

Este exemplo mostra como captar a intenção do pagamento especificado.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CapturePaymentIntent e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
    "PaymentIntentId": "pi_3Ogh4sANHgX3SHp72YB0YotA"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:CapturePaymentIntentconnectorOutputPayload

    [{
    "Success": "true",
    "id": "pi_3Ogh4sANHgX3SHp72YB0YotA",
    "object": "payment_intent",
    "amount": "33000",
    "amount_capturable": "0",
    "amount_received": "33000",
    "canceled_at": null,
    "cancellation_reason": null,
    "capture_method": "manual",
    "client_secret": "pi_3Ogh4sANHgX3SHp72YB0YotA_secret_jgqc0olEAOTcurQSDeQThJa3X",
    "confirmation_method": "automatic",
    "created": "1707196814",
    "currency": "usd",
    "customer": "cus_Okyi4e7t7BImUL",
    "description": null,
    "invoice": null,
    "last_payment_error": null,
    "latest_charge": "ch_3Ogh4sANHgX3SHp72uGBS7g4",
    "level3": null,
    "livemode": "false",
    "next_action": null,
    "on_behalf_of": null,
    "payment_method": "pm_1Ogh4FANHgX3SHp7GBJJvfGR",
    "payment_method_configuration_details": null,
    "payment_method_options.card.installments": null,
    "payment_method_types": null,
    "processing": null,
    "receipt_email": null,
    "review": null,
    "statement_descriptor_suffix": null,
    "status": "succeeded",
    "transfer_data": null,
    "transfer_group": null
    }]

Exemplo: cancelar intenção de pagamento

Este exemplo mostra como cancelar a intenção do pagamento especificado.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CancelPaymentIntent e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
    "PaymentIntentId": "pi_3Ogh7HANHgX3SHp738skMdSQ"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:CancelPaymentIntentconnectorOutputPayload

    [{
    "Success": "true",
    "id": "pi_3Ogh7HANHgX3SHp738skMdSQ",
    "object": "payment_intent",
    "amount": "33000",
    "amount_capturable": "0",
    "amount_received": "0",
    "canceled_at": "1707197160",
    "cancellation_reason": null,
    "capture_method": "manual",
    "client_secret": "pi_3Ogh7HANHgX3SHp738skMdSQ_secret_NqQsBexbdyk19ETdMnpQXF19j",
    "confirmation_method": "automatic",
    "created": "1707196963",
    "currency": "usd",
    "customer": "cus_Okyi4e7t7BImUL",
    "description": null,
    "invoice": null,
    "last_payment_error": null,
    "latest_charge": "ch_3Ogh7HANHgX3SHp73LJMZiy5",
    "level3": null,
    "livemode": "false",
    "next_action": null,
    "on_behalf_of": null,
    "payment_method": "pm_1Ogh75ANHgX3SHp79MNT6IHs",
    "payment_method_configuration_details": null,
    "receipt_email": null,
    "review": null,
    "setup_future_usage": null,
    "shipping": null,
    "status": "canceled",
    "transfer_data": null,
    "transfer_group": null
    }]

Exemplo: associe um método de pagamento a um cliente

Este exemplo mostra como anexar um método de pagamento ao cliente especificado.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AttachPaymentMethodToCustomer e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
    "PaymentMethodId": "pm_1OYm2nANHgX3SHp7ihGfm5U8",
    "CustomerId": "cus_PNX7n9xMDsMPH4"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:AttachPaymentMethodToCustomerconnectorOutputPayload

    [{
    "Success": "true"
    }]

Exemplo: desassocie o método de pagamento de um cliente

Este exemplo mostra como desassociar um método de pagamento de um cliente.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DetachPaymentMethodFromCustomer e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
    "PaymentMethodId": "pm_1OYm2nANHgX3SHp7ihGfm5U8"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:DetachPaymentMethodFromCustomerconnectorOutputPayload

    [{
    "Success": "true"
    }]

Exemplo: finalize uma fatura

Este exemplo mostra como finalizar uma fatura.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação FinalizeInvoice e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
    "InvoiceId": "in_1OhnXRANHgX3SHp73ufStlXy"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta Finalize Invoice connectorOutputPayload da tarefa tem um valor semelhante ao seguinte:

    [{
    "Success": "true",
    "id": "in_1OhnXRANHgX3SHp73ufStlXy",
    "object": "invoice",
    "account_country": "US",
    "account_name": "ZBTA_US_SAPDPA_TestAccount",
    "billing_reason": "manual",
    "charge": null,
    "collection_method": "charge_automatically",
    "created": "1707459976",
    "currency": "usd",
    "discounts": null,
    "due_date": null,
    "effective_at": "1707460034",
    "ending_balance": "0",
    "footer": null,
    "lines.data": null,
    "lines.has_more": "false",
    "lines.total_count": "0",
    "livemode": "false",
    "next_payment_attempt": null,
    "number": "F3C0E263-0004",
    "on_behalf_of": null,
    "paid": "true",
    "paid_out_of_band": "false",
    "payment_intent": null,
    }]

Exemplo: finalize um pedido de orçamento

Este exemplo mostra como finalizar um pedido de orçamento.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação FinalizeQuote e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
    "QuoteId": "qt_1ObiPfANHgX3SHp7KT7DXaJe"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta FinalizeQuoteconnectorOutputPayload da tarefa tem um valor semelhante ao seguinte:

    [{
    "Success": "true"
    }]

Exemplo: aceite uma estimativa do custo

Este exemplo mostra como aceitar um orçamento.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AcceptQuote e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
    "QuoteId": "qt_1ObmqKANHgX3SHp7ahHydwav"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:AcceptQuoteconnectorOutputPayload

    [{
    "InvoiceId": "in_1Obmr5ANHgX3SHp7HKi6bJDu",
    "Success": "true"
    }]

Exemplo: cancele uma estimativa de custo

Este exemplo mostra como cancelar um pedido de orçamento.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CancelQuote e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
    "QuoteId": "qt_1Obmu3ANHgX3SHp7as57wBLf"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:CancelQuoteconnectorOutputPayload

    [{
    "Success": "true"
    }]

Exemplos de operações de entidades

Esta secção mostra como realizar algumas das operações de entidades neste conector.

Exemplo: listar todos os clientes

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Customer na lista Entity.
  3. Selecione a operação List e, de seguida, clique em Concluído.
  4. Na secção Entrada de tarefas da tarefa Conetores, pode definir o filterClause de acordo com o requisito do cliente.
  5. Tem de usar aspas simples (') para incluir o valor de uma filterClause. Pode usar o elemento filterClause para filtrar registos com base nas colunas.

Exemplo: obter detalhes do cliente

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Customer na lista Entity.
  3. Selecione a operação Get e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conectores, clique em entityId e, em seguida, introduza cus_OxHsz0u5bCGWuy no campo Valor predefinido.

    Aqui, cus_OxHsz0u5bCGWuy é um ID de registo exclusivo na entidade Customer.

Exemplo: criar um cliente

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Customer na lista Entity.
  3. Selecione a operação Create e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
      "Name": "abc"
    }
    

    Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:

    {
      "Id": "cus_OxIqiMh1W335rE"
    }
    
    

Exemplo: crie um reembolso

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Refunds na lista Entity.
  3. Selecione a operação Create e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
      "Charge": "ch_3OU27zANHgX3SHp73HqiDsh3",
      "Amount": 10.0
    }
    

    Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:

    {
      "Id": "re_3OU27zANHgX3SHp73nxqZMF2"
    }
    

Exemplo: criar um cartão

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Cards na lista Entity.
  3. Selecione a operação Create e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
      "CustomerId": "cus_OmptWC2kb2264y",
      "Token": "tok_1O9kUPANHgX3SHp7WcrPumVI"
    }
    

    Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:

    {
      "Id": "card_1O9kUPANHgX3SHp7Q8Hsk35F",
      "CustomerId": "cus_OmptWC2kb2264y"
    }
    

Exemplo: crie um preço

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Prices na lista Entity.
  3. Selecione a operação Create e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
      "Currency": "usd",
      "Product": "prod_OlNe53LwNydXSx",
      "UnitAmount": 1200.0
    }
    

    Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:

    {
      "Id": "price_1OAR1TANHgX3SHp7EeiZTW9h"
    }
    

Exemplo: crie uma fatura

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Invoices na lista Entity.
  3. Selecione a operação Create e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
      "CustomerId": "cus_OhvXm2EI9bsFyN"
    }
    

    Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:

    {
      "Id": "in_1OXR9gANHgX3SHp7wHdnEe7U"
    }
    

Exemplo: criar um item de fatura

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione InvoiceItems na lista Entity.
  3. Selecione a operação Create e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
      "Customer": "cus_OksFS6F8HS7o5O",
      "Currency": "usd",
      "Amount": 1000.0
    }
    

    Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:

    {
      "Id": "ii_1OZAfAANHgX3SHp7xsd9o7Qm"
    }
    

Exemplo: crie uma estimativa de custo

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Quotes na lista Entity.
  3. Selecione a operação Create e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
      "CustomerId": "cus_POGecLC3f3hwk2"
    }
    

    Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:

    {
      "Id": "qt_1OZU92ANHgX3SHp75zJzMSvC"
    }
    

Exemplo: criar uma conta

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Accounts na lista Entity.
  3. Selecione a operação Create e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
      "Type": "standard"
    }
    

    Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:

    {
      "Id": "acct_1OZBcsQbE7mBlkdN"
    }
    

Exemplo: crie uma intenção de pagamento

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione PaymentIntent na lista Entity.
  3. Selecione a operação Create e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
    "PaymentMethod": "pm_1OXN5YANHgX3SHp7Q5Y0rb39",
    "Currency": "usd",
    "Amount": 1500.0
    }
    

    Se a integração for bem-sucedida, o parâmetro de connectorOutputPayloadresposta da tarefa do conector terá um valor semelhante ao seguinte:

    {
    "Id": "pi_3OXN69ANHgX3SHp70tgsxkuR"
    }

Exemplo: atualizar detalhes do cliente

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Customer na lista Entity.
  3. Selecione a operação Update e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
    "Name": "Charlie"
    }
  5. Clique em entityId e, de seguida, introduza cus_OxHsz0u5bCGWuy no campo Valor predefinido.

    Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector tem um valor semelhante ao seguinte:

    {
    "Id": "cus_OxHsz0u5bCGWuy"
    }

Exemplo: atualize uma intenção de pagamento

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione PaymentIntent na lista Entity.
  3. Selecione a operação Update e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
      "Description": "Payment Intent"
    }
    
  5. Defina o entityId como pi_3OWzKoANHgX3SHp70nE8QKyn. Para definir o entityId, clique em entityId e, de seguida, introduza pi_3OWzKoANHgX3SHp70nE8QKyn no campo Valor predefinido.

    Em vez de especificar o entityId, também pode definir a filterClause como 'pi_3OWzKoANHgX3SHp70nE8QKyn'.

    A execução deste exemplo devolve uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conetor:

    {
      "Id": "pi_3OWzKoANHgX3SHp70nE8QKyn"
    }
    

Exemplo: atualize os detalhes do cartão

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Cards na lista Entity.
  3. Selecione a operação Update e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
      "AddressCountry": "US",
      "Id": "card_1O9kUPANHgX3SHp7Q8Hsk35F",
      "CustomerId": "cus_OmptWC2kb2264y"
    }
    
  5. Defina filterClause como CustomerId = 'cus_OmptWC2kb2264y' e Id = 'card_1O9kUPANHgX3SHp7Q8Hsk35F'. Para definir o filterClause, clique em filterClause e, de seguida, introduza CustomerId = 'cus_OmptWC2kb2264y' and Id = 'card_1O9kUPANHgX3SHp7Q8Hsk35F' no campo Valor predefinido.

    A execução deste exemplo devolve uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conetor:

    {
      "result": [{
        "Id": "card_1O9kUPANHgX3SHp7Q8Hsk35F",
        "CustomerId": "cus_OmptWC2kb2264y"
      }]
    } 
    

Exemplo: atualize os detalhes do preço

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Prices na lista Entity.
  3. Selecione a operação Update e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
      "Nickname": "Price Update"
    }
    
  5. Defina o entityId como price_1O9nTjANHgX3SHp7Zr552abc. Para definir o entityId, clique em entityId e, de seguida, introduza price_1O9nTjANHgX3SHp7Zr552abc no campo Valor predefinido.

    Em vez de especificar o entityId, também pode definir a filterClause como 'price_1O9nTjANHgX3SHp7Zr552abc'.

    A execução deste exemplo devolve uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conetor:

    {
     "Id": "price_1O9nTjANHgX3SHp7Zr552abc"
    }
    

Exemplo: atualize uma fatura

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Invoices na lista Entity.
  3. Selecione a operação Update e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
      "Description": "Invoice for car"
    }
    
  5. Defina o entityId como in_1OA74xANHgX3SHp7YbC6x9R6. Para definir o entityId, clique em entityId e, de seguida, introduza in_1OA74xANHgX3SHp7YbC6x9R6 no campo Valor predefinido.

    Em vez de especificar o entityId, também pode definir a filterClause como 'in_1OA74xANHgX3SHp7YbC6x9R6'.

    A execução deste exemplo devolve uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conetor:

    {
      "Id": "in_1OA74xANHgX3SHp7YbC6x9R6"
    }
    

Exemplo: atualize um item de fatura

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione InvoiceItems na lista Entity.
  3. Selecione a operação Update e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
      "Quantity": 3.0
    }
    
  5. Defina o entityId como ii_1OZAfAANHgX3SHp7xsd9o7Qm. Para definir o entityId, clique em entityId e, de seguida, introduza ii_1OZAfAANHgX3SHp7xsd9o7Qm no campo Valor predefinido.

    A execução deste exemplo devolve uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conetor:

    {
      "Id": "ii_1OZAfAANHgX3SHp7xsd9o7Qm"
    }
    

Exemplo: atualize uma estimativa de custo

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Quotes na lista Entity.
  3. Selecione a operação Update e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
      "CustomerId": "cus_PQuEGGfutajbAs"
    }
    
  5. Defina o entityId como qt_1Oc2VaANHgX3SHp7PaM9Ph9o. Para definir o entityId, clique em entityId e, de seguida, introduza qt_1Oc2VaANHgX3SHp7PaM9Ph9o no campo Valor predefinido.

    A execução deste exemplo devolve uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conetor:

    {
      "Id": "qt_1Oc2VaANHgX3SHp7PaM9Ph9o"
    }
    

Exemplo: atualize os detalhes da conta

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Accounts na lista Entity.
  3. Selecione a operação Update e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:
    {
      "BusinessProfileName": "StagingName"
    }
    
  5. Defina o entityId como acct_1OZBcsQbE7mBlkdN. Para definir o entityId, clique em entityId e, de seguida, introduza acct_1OZBcsQbE7mBlkdN no campo Valor predefinido.

    A execução deste exemplo devolve uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conetor:

    
    {
      "Id": "acct_1OZBcsQbE7mBlkdN"
    }
    

Exemplo: elimine um cliente

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Customer na lista Entity.
  3. Selecione a operação Delete e, de seguida, clique em Concluído.
  4. Clique em entityId e, de seguida, introduza cus_OxIqiMh1W335rE no campo Valor predefinido.
  5. Se a entidade tiver duas chaves empresariais ou primárias compostas, em vez de especificar o entityId, pode definir o filterClause como id='cus_OxIqiMh1W335rE'.

Crie ligações com o Terraform

Pode usar o recurso do Terraform para criar uma nova associação.

Para saber como aplicar ou remover uma configuração do Terraform, consulte os comandos básicos do Terraform.

Para ver um modelo do Terraform de exemplo para a criação de ligações, consulte o modelo de exemplo.

Quando criar esta associação através do Terraform, tem de definir as seguintes variáveis no ficheiro de configuração do Terraform:

Nome do parâmetro Tipo de dados Obrigatória Descrição
proxy_enabled BOOLEAN Falso Selecione esta caixa de verificação para configurar um servidor proxy para a ligação.
proxy_auth_scheme ENUM Falso O tipo de autenticação a usar para autenticar no proxy ProxyServer. Os valores suportados são: BASIC, DIGEST, NONE
proxy_user STRING Falso Um nome de utilizador a ser usado para autenticar no proxy ProxyServer.
proxy_password SECRET Falso Uma palavra-passe a usar para autenticar no proxy ProxyServer.
proxy_ssltype ENUM Falso O tipo de SSL a usar quando se liga ao proxy ProxyServer. Os valores suportados são: AUTO, ALWAYS, NEVER, TUNNEL
account_id STRING Falso O ID da conta que quer usar.
verbosidade STRING Falso Nível de verbosidade para a ligação, varia de 1 a 5. Um nível de detalhe mais elevado regista todos os detalhes de comunicação (pedido,resposta e certificados SSL).

Obtenha ajuda da comunidade do Google Cloud

Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Cloud.

O que se segue?