Ir para o conteúdo

Conector QuickBooks OAuth 1.0a cria 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. Veja a Postagem do blog do desenvolvedor da Intuit de 10 de abril de 2019 e o Blog Intuit OAuth para obter informações adicionais.

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:

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 dentro do Jitterbit Design Studio.

Nota

Se você ainda não conhece o Harmony, pode visitar Guia de início rápido do Design Studio para 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. Entre usando as credenciais criadas quando você entrou na sua Organização durante o processo de inscrição através do site Harmony.

  2. A tela Getting Started deve ser exibida, onde você pode escolher fazer uma variedade de tarefas. Para o propósito deste tutorial, criaremos um novo projeto. Na parte inferior da aba da tela Getting Started, clique em New Project.

    1. Escolha um nome apropriado para seu novo projeto e então selecione outras configurações que sejam apropriadas para sua Organização. Para fins deste exemplo, chamaremos nosso projeto de "QuickBooks OAuth 1.0a".
    2. Se esta for 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. Depois que seu novo projeto for criado, sua tela deverá ser semelhante à imagem mostrada abaixo. O lado mais à esquerda 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 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 visto na imagem abaixo, e selecione Novo QuickBooks Endpoint na lista.

    anexo

  4. No lado direito da tela, você deve ver uma nova aba no seu espaço de trabalho chamada QuickBooks Endpoints. É aqui que você configurará a capacidade de conectar o Harmony à sua instância do sandbox do QuickBooks usando os valores que foram 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 Keys na página My Apps no site Intuit Developer. A Consumer Key também foi usada no OAuth Playground para gerar o Access Token e o Token Secret.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie a Chave do Consumidor da página OAuth Playground e cole no campo Chave do Consumidor na guia de teste QuickBooks Endpoint no Design Studio, conforme mostrado na imagem acima.
    4. Segredo do consumidor: O segredo do consumidor é gerado durante a criação do aplicativo QuickBooks, conforme descrito em Conector QuickBooks OAuth 1.0a - criar aplicativo QuickBooks e está localizado na aba Keys na página My Apps no site Intuit Developer. O Consumer Secret também foi usado no OAuth Playground para gerar o Access Token e o Token Secret.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie o Consumer Secret da página OAuth Playground e cole no campo Consumer Secret na guia de teste QuickBooks Endpoint no Design Studio, conforme mostrado na imagem acima.
    5. Token de acesso: O token de acesso é gerado no QuickBooks OAuth Playground conforme descrito em Conector QuickBooks OAuth 1.0a - criar aplicativo QuickBooks.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie o Token de acesso da página OAuth Playground e cole no campo Token de acesso na guia de teste QuickBooks Endpoint no Design Studio, conforme mostrado na imagem acima.
    6. Token Secret: O Token Secret é gerado no QuickBooks OAuth Playground conforme descrito em Conector QuickBooks OAuth 1.0a - criar aplicativo QuickBooks.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie o Token Secret da janela do navegador e cole no aba Token Secret na guia de teste QuickBooks Endpoint no Design Studio, conforme mostrado na imagem acima.
    7. ID do Realm: O ID do Realm é gerado no QuickBooks OAuth Playground, conforme descrito em Conector QuickBooks 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 de teste QuickBooks Endpoint no Design Studio, conforme mostrado na imagem acima.
    8. Token do APP: O token do aplicativo é gerado no site do desenvolvedor da Intuit, conforme descrito em Conector QuickBooks OAuth 1.0a - criar aplicativo QuickBooks e está localizado na aba Chaves na página Meus aplicativos no site do Intuit Developer.
      • Retorne à janela do navegador aberta exibindo a aba Painel dentro do seu aplicativo no site Intuit Developer.
      • Selecione a aba Chaves.
      • Na seção Chaves de desenvolvimento na aba Chaves, clique no botão Copiar à direita do Token do aplicativo e cole no campo Token do aplicativo na guia de teste QuickBooks Endpoint no Design Studio, aba mostrado na imagem acima.
    9. URL: Este valor é a URL do ambiente sandbox do QuickBooks ou do ambiente de produção do QuickBooks, dependendo de qual você estiver usando. Ele pode ser copiado e colado no seu campo de texto de URL, conforme mostrado na imagem acima:
    10. Ambiente Sandbox: https://sandbox-quickbooks.api.intuit.com/v3/company

  5. Depois que todos os valores necessários forem fornecidos, 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 Testar conexão. O seguinte pop-up deve ser exibido quando o Harmony tiver se 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 Harmony tiver se conectado com sucesso à sua instância do 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 consultar

Conector QuickBooks - criar atividades

Conector QuickBooks - atualizar atividades

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.

  1. Abra o aplicativo Design Studio, versão 8.10 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.
  2. No lado esquerdo do Design Studio, role para baixo até ver a categoria Connectors. Clique duas vezes no QuickBooks Connector para que as atividades subjacentes fiquem visíveis.
  3. Clique com o botão direito do mouse em QuickBooks Endpoints e selecione Novo QuickBooks Endpoint na lista.

  4. No lado direito da tela, você deve ver uma nova aba no seu espaço 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 que foram 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 Keys na página My Apps no site Intuit Developer. A Consumer Key também foi usada no OAuth Playground para gerar o Access Token e o Token Secret.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie a Chave do Consumidor da página OAuth Playground e cole no campo Chave do Consumidor na guia de produção QuickBooks Endpoint no Design Studio, conforme mostrado na imagem acima.
    4. Segredo do consumidor: O segredo do consumidor é gerado durante a criação do aplicativo QuickBooks, conforme descrito em Conector QuickBooks OAuth 1.0a - criar aplicativo QuickBooks e está localizado na aba Keys na página My Apps no site Intuit Developer. O Consumer Secret também foi usado no OAuth Playground para gerar o Access Token e o Token Secret.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie o Consumer Secret da página OAuth Playground e cole no campo Consumer Secret na aba de produção QuickBooks Endpoint no Design Studio, conforme mostrado na imagem acima.
    5. Token de acesso: O token de acesso é gerado no QuickBooks OAuth Playground conforme descrito em Conector QuickBooks OAuth 1.0a - criar aplicativo QuickBooks.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie o Token de acesso da página OAuth Playground e cole no campo Token de acesso na aba QuickBooks Endpoint de produção no Design Studio, conforme mostrado na imagem acima.
    6. Token Secret: O Token Secret é gerado no QuickBooks OAuth Playground conforme descrito em Conector QuickBooks OAuth 1.0a - criar aplicativo QuickBooks.
      • Retorne à janela do navegador aberta exibindo a página OAuth Playground.
      • Copie o Token Secret da janela do navegador e cole no aba Token Secret na guia de produção QuickBooks Endpoint no Design Studio, conforme mostrado na imagem acima.
    7. ID do Realm: O ID do Realm é gerado no QuickBooks OAuth Playground, conforme descrito em Conector QuickBooks 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 guia de produção QuickBooks Endpoint no Design Studio, conforme mostrado na imagem acima.
    8. Token do APP: O token do aplicativo é gerado no site do desenvolvedor da Intuit, conforme descrito em Conector QuickBooks OAuth 1.0a - criar aplicativo QuickBooks e está localizado na aba Chaves na página Meus aplicativos no site do Intuit Developer.
      • Retorne à janela do navegador aberta exibindo a aba Painel dentro do seu aplicativo no site Intuit Developer.
      • Selecione a aba Chaves.
      • Role para baixo até a seção Chaves de produção na aba Chaves, clique no botão Copiar à direita do Token do aplicativo e cole no campo Token do aplicativo na aba QuickBooks Endpoint de produção no Design Studio, conforme mostrado na imagem acima.
    9. URL: Este valor é a URL do ambiente sandbox do QuickBooks ou do ambiente de produção do QuickBooks, dependendo de qual você estiver usando. Ele pode ser copiado e colado no seu campo de texto de URL, conforme mostrado na imagem acima:
    10. Ambiente de produção: https://quickbooks.api.intuit.com/v3/company

  5. Depois que todos os valores necessários forem fornecidos, 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 Testar conexão. O seguinte pop-up deve ser exibido quando o Harmony tiver se 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óxima etapa: Depois que seu endpoint Harmony estiver 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 consultar

Conector QuickBooks - criar atividades

Conector QuickBooks - atualizar atividades

Conector QuickBooks - excluir atividades