Ir para o conteúdo

QuickBooks Connector OAuth 1.0a Criar um Endpoint

Aviso

Todos os usuários existentes do QuickBooks devem migrar para a autenticação OAuth 2.0 até 17 de dezembro de 2019. Consulte a Postagem do blog do desenvolvedor da Intuit em 10 de abril de 2019 e o blog Intuit OAuth para obter informações adicionais.

Antes de iniciar as etapas nesta página, você já deve ter concluído estas atividades de configuração para permitir o acesso do Harmony à sua instância do QuickBooks Online:

Neste ponto, você deve ter todas as informações necessárias para começar a trabalhar no Harmony. Esta página descreve como usar o Harmony QuickBooks Connector para criar um endpoint no Harmony Design Studio.

Nota

Se você ainda não está familiarizado com o Harmony, pode visitar o Guia de início rápido do Design Studio para obter informações detalhadas sobre como usar o produto. Para o propósito desta documentação, exemplos simples são usados como demonstração.

Endpoint de Teste

  1. Abra o aplicativo Design Studio, versão 8.10 ou posterior. Faça login usando as credenciais criadas quando você ingressou na sua organização durante o processo de inscrição por meio do site do Harmony.

  2. A tela Introdução deve ser exibida, onde você pode optar por executar várias tarefas. Para o propósito deste passo a passo, criaremos um novo projeto. Na parte inferior da aba da tela Introdução, clique em Novo projeto.

    1. Escolha um nome apropriado para seu novo projeto e selecione outras configurações apropriadas para sua organização. Para fins deste exemplo, chamaremos nosso projeto de "QuickBooks OAuth 1.0a".
    2. Se esta é a primeira vez que você usa o Design Studio, você pode aceitar todos os valores padrão.
    3. Se você já usou o Design Studio anteriormente, talvez queira alterar as configurações selecionadas conforme apropriado.

    4. Clique no botão Criar.

      anexo

  3. Uma vez criado seu novo projeto, sua tela deverá ficar semelhante à imagem abaixo. O lado esquerdo do Design Studio mostra as diferentes partes de sua integração: Operações, Transformações etc. No lado esquerdo, role para baixo até ver a categoria Conectores. Clique duas vezes no Conector do QuickBooks para que as atividades subjacentes fiquem visíveis. Em seguida, clique com o botão direito do mouse em QuickBooks Endpoints conforme mostrado na imagem abaixo e selecione New QuickBooks Endpoint na lista.

    anexo

  4. No lado direito da tela, você verá uma nova aba em sua área de trabalho chamada QuickBooks Endpoints. É aqui que você configurará a capacidade de conectar o Harmony à sua instância de sandbox do QuickBooks usando os valores obtidos anteriormente nesta documentação.

    anexo

    1. Insira um nome apropriado para o endpoint no campo Nome. Para fins deste exemplo, chamaremos nosso endpoint de "QuickBooks Endpoint OAuth 1.0a".
    2. Selecione o botão de opção** OAuth1**. A aba agora exibirá os campos de dados específicos necessários para criar um endpoint QuickBooks OAuth 1.0a.
    3. Chave do Consumidor: A Chave do Consumidor é gerada durante a criação do aplicativo QuickBooks, conforme descrito em Conector QuickBooks OAuth 1.0a - Criar aplicativo QuickBooks e está localizado na aba Chaves na página Meus aplicativos no site Intuit Developer. A chave do consumidor também foi usada no OAuth Playground para gerar o token de acesso e o segredo do token.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie Consumer Key da página OAuth Playground e cole no campo Consumer Key dentro da aba QuickBooks Endpoint de teste no Design Studio como mostrado na imagem acima.
    4. Consumer Secret: O Consumer Secret é gerado durante a criação do aplicativo QuickBooks, conforme descrito em QuickBooks Connector OAuth 1.0a - Criar aplicativo QuickBooks e está localizado na aba Chaves na página Meus aplicativos no site Intuit Developer. O segredo do consumidor também foi usado no OAuth Playground para gerar o token de acesso e o segredo do token.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie Consumer Secret da página OAuth Playground e cole no campo Consumer Secret dentro da aba QuickBooks Endpoint de teste no Design Studio como mostrado na imagem acima.
    5. Token de acesso: O token de acesso é gerado no QuickBooks OAuth Playground, conforme descrito em QuickBooks Connector OAuth 1.0a - Criar aplicativo QuickBooks.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie o Access Token da página OAuth Playground e cole no campo Access Token dentro da aba QuickBooks Endpoint de teste no Design Studio como mostrado na imagem acima.
    6. Token Secret: O Token Secret é gerado no QuickBooks OAuth Playground, conforme descrito em QuickBooks Connector OAuth 1.0a - Criar aplicativo QuickBooks.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie Token Secret da janela do navegador e cole no campo Token Secret dentro da aba QuickBooks Endpoint de teste no Design Studio como mostrado na imagem acima.
    7. ID do Realm: O ID do Realm é gerado no QuickBooks OAuth Playground, conforme descrito em QuickBooks Connector OAuth 1.0a - Criar aplicativo QuickBooks.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie o RealmId da janela do navegador e cole no campo Realm ID dentro da aba QuickBooks Endpoint de teste no Design Studio, conforme mostrado na imagem acima.
    8. APP Token: App Token é gerado no site Intuit Developer, conforme descrito em QuickBooks Connector OAuth 1.0a - Criar aplicativo QuickBooks e está localizado na aba Chaves na página Meus aplicativos no site Intuit Developer.
      • Retorne à janela do navegador aberta, exibindo a aba Painel em seu aplicativo no site Intuit Developer.
      • Selecione a aba Chaves.
      • Na seção Chaves de desenvolvimento da aba Chaves, clique no botão Copiar à direita de Token de aplicativo e cole no Campo App Token na guia QuickBooks Endpoint de teste no Design Studio, conforme mostrado na imagem acima.
    9. URL: Este valor é o URL do ambiente de sandbox do QuickBooks ou do ambiente de produção do QuickBooks, dependendo de qual você está usando. Ele pode ser copiado e colado no campo de texto da URL, conforme mostrado na imagem acima:
    10. Ambiente Sandbox: https://sandbox-quickbooks.api.intuit.com/v3/company

  5. Após fornecer todos os valores necessários, clique no ícone Salvar** na barra de ferramentas do Design Studio.

  6. A conexão deve ser testada para verificar se tudo está configurado corretamente. Para fazer isso, clique no botão Test Connection. O pop-up a seguir deve ser exibido assim que o Harmony for conectado com sucesso ao QuickBooks.

    anexo

  7. A mensagem acima confirma que a conexão sandbox recém-criada é válida e está funcionando. Se a conexão não for bem-sucedida, os valores fornecidos devem ser verificados duas vezes para garantir que não haja espaços adicionais ou que um valor não tenha sido totalmente copiado e colado em uma das propriedades da conexão.

Próxima etapa: depois que seu endpoint do Harmony for conectado com êxito à instância de sandbox do QuickBooks, a próxima etapa será criar as atividades apropriadas para integrar sua instância do QuickBooks Online a outros programas e aplicativos.

Conector do QuickBooks - Atividades de consulta

Conector do QuickBooks - Criar atividades

Conector do QuickBooks - Atualizar atividades

Conector do QuickBooks - Excluir atividades

Endpoint de Produção

Quando estiver pronto para trazer sua integração para um ambiente de produção, siga as etapas abaixo para criar um endpoint de produção no Design Studio.

  1. Abra o aplicativo Design Studio, versão 8.10 ou posterior. Selecione um projeto existente do QuickBooks na aba Recent Projects e clique no botão Open ou clique na aba New Project e crie um novo projeto.
  2. No lado esquerdo do Design Studio, role para baixo até ver a categoria Connectors. Clique duas vezes no Conector do QuickBooks para que as atividades subjacentes fiquem visíveis.
  3. Clique com o botão direito em QuickBooks Endpoints e selecione Novo QuickBooks Endpoint na lista.

  4. No lado direito da tela, você verá uma nova aba em sua área de trabalho chamada QuickBooks Endpoints. É aqui que você configurará a capacidade de conectar o Harmony à sua instância de produção do QuickBooks usando os valores obtidos anteriormente nesta documentação.

    anexo

    1. Insira um nome apropriado para o endpoint no campo Nome. Para fins deste exemplo, chamaremos nosso endpoint de "QuickBooks Endpoint 1.0 Prod".
    2. Selecione o botão de opção** OAuth1**. A aba agora exibirá os campos de dados específicos necessários para criar um endpoint QuickBooks OAuth 1.0a.
    3. Chave do Consumidor: A Chave do Consumidor é gerada durante a criação do aplicativo QuickBooks, conforme descrito em Conector QuickBooks OAuth 1.0a - Criar aplicativo QuickBooks e está localizado na aba Chaves na página Meus aplicativos no site Intuit Developer. A chave do consumidor também foi usada no OAuth Playground para gerar o token de acesso e o segredo do token.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie Consumer Key da página OAuth Playground e cole no campo Consumer Key na aba QuickBooks Endpoint de produção no Design Studio como mostrado na imagem acima.
    4. Consumer Secret: O Consumer Secret é gerado durante a criação do aplicativo QuickBooks, conforme descrito em QuickBooks Connector OAuth 1.0a - Criar aplicativo QuickBooks e está localizado na aba Chaves na página Meus aplicativos no site Intuit Developer. O segredo do consumidor também foi usado no OAuth Playground para gerar o token de acesso e o segredo do token.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie Consumer Secret da página OAuth Playground e cole no campo Consumer Secret dentro da aba QuickBooks Endpoint de produção no Design Studio como mostrado na imagem acima.
    5. Token de acesso: O token de acesso é gerado no QuickBooks OAuth Playground, conforme descrito em QuickBooks Connector OAuth 1.0a - Criar aplicativo QuickBooks.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie o Access Token da página OAuth Playground e cole no campo Access Token na aba QuickBooks Endpoint de produção no Design Studio como mostrado na imagem acima.
    6. Token Secret: O Token Secret é gerado no QuickBooks OAuth Playground, conforme descrito em QuickBooks Connector OAuth 1.0a - Criar aplicativo QuickBooks.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie Token Secret da janela do navegador e cole no campo Token Secret na aba QuickBooks Endpoint de produção no Design Studio como mostrado na imagem acima.
    7. ID do Realm: O ID do Realm é gerado no QuickBooks OAuth Playground, conforme descrito em QuickBooks Connector OAuth 1.0a - Criar aplicativo QuickBooks.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie o RealmId da janela do navegador e cole no campo Realm ID na aba QuickBooks Endpoint de produção no Design Studio, conforme mostrado na imagem acima.
    8. APP Token: App Token é gerado no site Intuit Developer, conforme descrito em QuickBooks Connector OAuth 1.0a - Criar aplicativo QuickBooks e está localizado na aba Chaves na página Meus aplicativos no site Intuit Developer.
      • Retorne à janela do navegador aberta, exibindo a aba Painel em seu aplicativo no site Intuit Developer.
      • Selecione a aba Chaves.
      • Role para baixo até a seção Production Keys na aba Keys, clique no botão Copy à direita do App Token e cole no campo App Token na aba QuickBooks Endpoint de produção no Design Studio, conforme mostrado na imagem acima.
    9. URL: Este valor é o URL do ambiente de sandbox do QuickBooks ou do ambiente de produção do QuickBooks, dependendo de qual você está usando. Ele pode ser copiado e colado no campo de texto da URL, conforme mostrado na imagem acima:
    10. Ambiente de produção: https://quickbooks.api.intuit.com/v3/company

  5. Após fornecer todos os valores necessários, clique no ícone Salvar** na barra de ferramentas do Design Studio.

  6. A conexão deve ser testada para verificar se tudo está configurado corretamente. Para fazer isso, clique no botão Test Connection. O pop-up a seguir deve ser exibido assim que o Harmony for conectado com sucesso ao QuickBooks.

    anexo

  7. A mensagem acima confirma que a conexão de produção recém-criada é válida e está funcionando. Se a conexão não for bem-sucedida, os valores fornecidos devem ser verificados duas vezes para garantir que não haja espaços adicionais ou que um valor não tenha sido totalmente copiado e colado em uma das propriedades da conexão.

Próximo passo: Depois que seu endpoint Harmony for conectado com sucesso à sua instância de produção do QuickBooks, seu próximo passo é criar as atividades apropriadas para integrar sua instância do QuickBooks Online com outros programas e aplicativos.

Conector do QuickBooks - Atividades de consulta

Conector do QuickBooks - Criar atividades

Conector do QuickBooks - Atualizar atividades

Conector do QuickBooks - Excluir atividades