QuickBooks Connector OAuth 2.0 Criar um Endpoint¶
Nota
QuickBooks Connector OAuth 2.0 é compatível com um Harmony Grupo de Agentes Privados. O conector não é compatível com Harmony Grupos de Agentes em Nuvem.
Antes de iniciar as etapas desta 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:
- QuickBooks Connector OAuth 2.0 - Criar aplicativo QuickBooks
- Instale o Jitterbit Design Studio no Windows ou Instale o Jitterbit Design Studio no macOS
- Instale um Agente Harmony Windows ou Instalar um Agente Harmony Linux
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, você pode visitar o Guia de início rápido do Design Studio para obter informações detalhadas sobre como usar o produto. Para efeitos desta documentação, exemplos simples são usados como demonstração.
Endpoint de Teste¶
- Abra o aplicativo Design Studio, versão 8.29.2 ou posterior. Faça login usando as credenciais criadas quando você ingressou na sua organização durante o processo de inscrição no site do Harmony.
-
A tela Introdução deverá ser exibida, onde você poderá optar por realizar diversas tarefas. Para efeitos deste passo a passo, criaremos um novo projeto. Na parte aba da tela Introdução, clique em Novo Projeto.
- 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 New OAuth 2”.
- Se esta for a primeira vez que você usa o Design Studio, você pode aceitar todos os valores padrão.
- Se você já usou o Design Studio anteriormente, talvez queira alterar as configurações selecionadas conforme apropriado.
-
Clique no botão Criar.
-
Depois de criado seu novo projeto, sua tela deverá ficar semelhante à imagem mostrada abaixo. O lado esquerdo do Design Studio mostra as diferentes partes da sua integração: Operações, Transformações, etc. No lado esquerdo, role para baixo até ver a categoria Conectores. Clique duas vezes em QuickBooks Connector para que as atividades subjacentes fiquem visíveis.
-
Em seguida, clique com o botão direito em QuickBooks Endpoints conforme visto na imagem abaixo e selecione New QuickBooks Endpoint na lista.
-
No lado direito da tela, você deverá 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.
- Insira um nome apropriado para o endpoint no campo Nome. Para fins deste exemplo, chamaremos nosso endpoint de "Novo Endpoint do QuickBooks ".
- Selecione o botão de opção OAuth2. A aba agora exibirá os campos de dados específicos necessários para criar um endpoint QuickBooks OAuth 2.0.
- Realm ID: O Realm ID é gerado no QuickBooks OAuth 2.0 Playground conforme descrito em QuickBooks Connector OAuth 2.0 - Criar aplicativo QuickBooks.
- Retorne à janela aberta do navegador que exibe a página do OAuth 2.0 Playground.
- Copie o Realm ID da janela do navegador e cole no campo Realm ID na aba New QuickBooks Endpoint no Design Studio como mostrado na imagem acima.
- *Código de autorização: *O código de autorização é gerado no QuickBooks OAuth 2.0 Playground conforme descrito em QuickBooks Connector OAuth 2.0 - Criar aplicativo QuickBooks.
- Retorne à janela aberta do navegador que exibe a página do OAuth 2.0 Playground.
- Copie o Código de autorização da janela do navegador e cole no campo Código de autorização na aba Novo Endpoint do QuickBooks no Design Studio como mostrado na imagem acima.
- ID do cliente: O ID do cliente é gerado durante a criação do aplicativo QuickBooks, conforme descrito em QuickBooks Connector OAuth 2.0 - Criar aplicativo QuickBooks.
- Retorne à janela aberta do navegador que exibe a página do OAuth 2.0 Playground.
- No menu na parte superior da página, clique em Meus aplicativos.
- Selecione o aplicativo que você criou durante o estágio de teste e desenvolvimento especificamente para configurar o Harmony QuickBooks Connector.
- Clique na aba Chaves.
- As Chaves de Desenvolvimento são exibidas na parte superior da página.
- Clique no botão Copiar à direita de ID do cliente na aba Chaves e cole no campo ID do cliente dentro do Nova aba QuickBooks Endpoint no Design Studio, conforme mostrado na imagem acima.
- Segredo do cliente: O segredo do cliente é gerado durante a criação do aplicativo QuickBooks conforme descrito em QuickBooks Connector OAuth 2.0 - Criar aplicativo QuickBooks.
- Retorne à janela aberta do navegador exibindo as Chaves de Desenvolvimento.
- Clique no botão Copiar à direita de Segredo do cliente na aba Chaves e cole no campo Segredo do cliente dentro do Nova aba QuickBooks Endpoint no Design Studio, conforme mostrado na imagem acima.
- URL: Este valor é o URL do ambiente 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 do seu URL, conforme mostrado na imagem acima:
- Ambiente Sandbox: Https://sandbox-quickbooks.api.intuit.com/v3/company
- Depois que todos os valores necessários forem fornecidos, clique no ícone Salvar** na barra de ferramentas do Design Studio.
- A conexão deve ser testada para verificar se tudo está configurado corretamente. Para fazer isso, clique no botão Testar conexão. O pop-up a seguir deve ser exibido assim que o Harmony for conectado com sucesso ao QuickBooks.
- 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 deverão 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.
Configurando a Conexão com QuickBooks Sandbox em Vários Agentes¶
Se o seu grupo de agentes privados contiver mais de um agente privado, conclua estas etapas:
- QuickBooks cria este arquivo quando a conexão é bem-sucedida: "C:\ProgramData\qbdata\qbdata.properties". Este arquivo é criado em apenas um dos agentes privados do grupo de agentes, mas é necessário para que QuickBooks se comuniquem com cada agente.
- Pesquise cada agente privado dentro do grupo de agentes para determinar em qual agente reside o arquivo "qbdata.properties".
- Copie toda a pasta "\qbdata" para a pasta "c:\ProgramData" em cada um dos agentes restantes do grupo de agentes. Isso permite que todos os agentes do grupo de agentes se comuniquem com QuickBooks.
Próxima etapa: Depois que seu endpoint Harmony for conectado com sucesso à sua instância de sandbox do QuickBooks, a próxima etapa é criar as atividades apropriadas para integrar sua instância do QuickBooks Online com outros programas e aplicativos.
Conector QuickBooks - Atividades de consulta
Conector QuickBooks - Criar atividades
Conector QuickBooks - Atividades de atualização
Conector QuickBooks - Excluir atividades
Endpoint de Produção¶
Quando estiver pronto para levar sua integração para um ambiente de produção, siga as etapas abaixo para criar um endpoint de produção no Design Studio.
- Abra o aplicativo Design Studio, versão 8.29.2 ou posterior. Selecione um projeto QuickBooks existente na aba Projetos recentes e clique no botão Abrir ou clique na aba Novo projeto e crie um novo projeto.
- No lado esquerdo do Design Studio, role para baixo até ver a categoria Conectores. Clique duas vezes em QuickBooks Connector para que as atividades subjacentes fiquem visíveis.
- Clique com o botão direito em QuickBooks Endpoints e selecione Novo QuickBooks Endpoint na lista.
- No lado direito da tela, você deverá 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.
- Insira um nome apropriado para o endpoint no campo Nome. Para fins deste exemplo, chamaremos nosso endpoint de “QuickBooks Production”.
- Selecione o botão de opção** OAuth2**. A aba agora exibirá os campos de dados específicos necessários para criar um endpoint QuickBooks OAuth 2.0.
- Realm ID: O Realm ID é gerado no QuickBooks OAuth 2.0 Playground conforme descrito em QuickBooks Connector OAuth 2.0 - Criar aplicativo QuickBooks.
- Retorne à janela aberta do navegador que exibe a página do OAuth 2.0 Playground.
- Copie o Realm ID da janela do navegador e cole no campo Realm ID na aba QuickBooks Endpoint no Design Studio, conforme mostrado na imagem acima.
- Código de autorização: O código de autorização é gerado no QuickBooks OAuth 2.0 Playground conforme descrito em QuickBooks Connector OAuth 2.0 - Criar aplicativo QuickBooks.
- Retorne à janela aberta do navegador que exibe a página do OAuth 2.0 Playground.
- Copie o Código de autorização da janela do navegador e cole no campo Código de autorização na aba QuickBooks Endpoint no Design Studio, conforme mostrado na imagem acima.
- ID do cliente: O ID do cliente é gerado durante a criação do aplicativo QuickBooks, conforme descrito em QuickBooks Connector OAuth 2.0 - Criar aplicativo QuickBooks.
- Retorne à janela aberta do navegador que exibe a página do OAuth 2.0 Playground.
- No menu na parte superior da página, clique em Meus aplicativos.
- Selecione o aplicativo que você criou durante o estágio de teste e desenvolvimento especificamente para configurar o Harmony QuickBooks Connector.
- Clique na aba Chaves.
- Role para baixo até a seção Chaves de produção.
- Clique no botão Mostrar à direita de ID do cliente na aba Chaves. O ID do cliente é exibido.
- Clique no botão Copiar à direita de ID do cliente e cole no campo ID do cliente na aba Endpoint do QuickBooks em Design Studio conforme imagem acima.
- Segredo do cliente: O segredo do cliente é gerado durante a criação do aplicativo QuickBooks conforme descrito em QuickBooks Connector OAuth 2.0 - Criar aplicativo QuickBooks.
- Retorne à janela aberta do navegador que exibe a seção Chaves de produção.
- Clique no botão Mostrar à direita de Segredo do cliente na aba Chaves. O segredo do cliente é exibido.
- Clique no botão Copiar à direita de Segredo do cliente e cole no campo Segredo do cliente na aba Endpoint do QuickBooks em Design Studio conforme imagem acima.
- URL: Este valor é o URL do ambiente 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 do seu URL, conforme mostrado na imagem acima:
- Ambiente de produção: Https://quickbooks.api.intuit.com/v3/company
- Depois que todos os valores necessários forem fornecidos, clique no ícone Salvar** na barra de ferramentas do Design Studio.
- A conexão deve ser testada para verificar se tudo está configurado corretamente. Para fazer isso, clique no botão Testar conexão. O pop-up a seguir deve ser exibido assim que o Harmony for conectado com sucesso ao QuickBooks.
- 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 deverão 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.
Configurando a Conexão com Produção de QuickBooks em Vários Agentes¶
Se o seu grupo de agentes privados contiver mais de um agente privado, conclua estas etapas:
- QuickBooks cria este arquivo quando a conexão é bem-sucedida: "C:\ProgramData\qbdata\qbdata.properties". Este arquivo é criado em apenas um dos agentes privados do grupo de agentes, mas é necessário para que QuickBooks se comuniquem com cada agente.
- Pesquise cada agente privado dentro do grupo de agentes para determinar em qual agente reside o arquivo "qbdata.properties".
- Copie toda a pasta "\qbdata" para a pasta "c:\ProgramData" em cada um dos agentes restantes do grupo de agentes. Isso permite que todos os agentes do grupo de agentes se comuniquem com QuickBooks.
Dica
Próxima etapa: Depois que seu endpoint Harmony for conectado com sucesso à sua instância de produção do QuickBooks, a próxima etapa é criar as atividades apropriadas para integrar sua instância do QuickBooks Online com outros programas e aplicativos.
Conector QuickBooks - Atividades de consulta
Conector QuickBooks - Criar atividades