Conector QuickBooks OAuth 1.0a cria um aplicativo QuickBooks
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 começar, certifique-se de atender aos requisitos definidos em Conector QuickBooks OAuth 1.0a - pré-requisitos.
Configurar um aplicativo QuickBooks Online é a primeira das duas principais atividades que você precisa executar no QuickBooks para permitir o acesso do Jitterbit à sua instância do QuickBooks Online. Durante a criação do seu aplicativo QuickBooks Online, você também gerará um App Token, Consumer Key, Consumer Secret, Access Token e Access Secret exclusivos para inserir no Jitterbit Design Studio posteriormente no processo de configuração.
As etapas a seguir mostram como criar seu aplicativo QuickBooks Online dentro do QuickBooks.
Ambiente de teste
Estas etapas pressupõem que você esteja usando uma conta sandbox do QuickBooks ao desenvolver e testar sua integração.
-
Acesse https://developer.intuit.com/ e faça login usando as credenciais da sua conta do QuickBooks.
-
No menu no topo da página, clique em Meus Apps. Se você já tiver aplicativos existentes criados em sua conta, você os verá listados aqui. Selecione o botão Criar novo aplicativo para ir para a próxima página. Se você ainda não tiver nenhum aplicativo criado, você já estará na página descrita na próxima etapa.
-
Agora você deve ver uma página similar à mostrada abaixo. Na seção Just start coding, clique no botão Select APIs.
-
Um pop-up deve pedir para você selecionar a API. A API "Contabilidade" é a API principal para integração com o QuickBooks Online e deve ser selecionada para integração com o Harmony. Marque a caixa para a API de Contabilidade e clique no botão Criar aplicativo.
-
Após seu aplicativo ser criado, você será direcionado para sua aba Dashboard na seção Development. A página Dashboard mostra as etapas que você precisará seguir para configurar seu novo aplicativo. Como seu aplicativo acabou de ser criado, ele terá um nome padrão de "Unknown".
Nota
Você pode retornar ao seu aplicativo a qualquer momento voltando para Meus aplicativos no menu no topo de qualquer página.
-
Vá para a aba Keys. As chaves listadas nesta página são pré-geradas para seu novo aplicativo. Essas chaves serão necessárias em partes posteriores desta documentação – tanto quando você gerar tokens de acesso, quanto para o App Token exclusivo para entrar no Design Studio mais tarde. Você retornará a esta aba mais tarde.
-
Vá para a aba Configurações. Aqui é onde você pode alterar o título do seu novo aplicativo, bem como outras informações dependendo do seu projeto de integração específico. Clique na parte que você deseja editar para alterar qualquer informação do seu aplicativo e clique no botão Salvar quando as alterações forem concluídas. Neste exemplo, o nome do aplicativo é alterado para "JBTestOAuth1".
-
Retorne à aba Dashboard. Na seção Resources, clique no link OAuth Playground.
-
Agora você deve ver uma página semelhante à mostrada abaixo, indicando que você está no OAuth Playground.
- Altere a Duração do Token de Acesso da configuração padrão de 120 segundos para um número grande, por exemplo, 14000000 segundos. Esse é o período de tempo em que seu token de acesso será válido, após o qual você precisará gerar um novo token para conexão com seu aplicativo QuickBooks.
- Clique no botão Conectar ao QuickBooks no meio da tela.
-
Uma mensagem de aviso pop-up indica que você sairá do site. Selecione o botão Sair.
-
Agora você deve ver uma página semelhante à página mostrada abaixo. Esta é a etapa final dentro do QuickBooks para autorizar o Harmony QuickBooks Connector a acessar seus dados do QuickBooks Online. Selecione o botão Connect.
-
Agora você deve ver uma página semelhante à página mostrada abaixo e exibindo Access Token, Access Token Secret e RealmId, bem como Consumer Key e Consumer Secret. Essas credenciais serão necessárias em seções posteriores desta documentação para entrar no Design Studio. Deixe esta página aberta no seu navegador, pois você precisará retornar aqui mais tarde.
Próxima etapa: Conector QuickBooks OAuth 1.0a - criar endpoint
Ambiente de produção
Quando estiver pronto para levar sua integração para um ambiente de produção, siga as etapas abaixo para obter chaves de produção específicas para seu aplicativo.
-
Acesse https://developer.intuit.com/ e faça login usando as credenciais da sua conta do QuickBooks.
-
No menu no topo da página, clique em Meus Apps. Selecione o aplicativo que você criou durante o estágio de teste e desenvolvimento especificamente para configurar o Harmony QuickBooks Connector.
-
Agora você deve ver uma página similar à mostrada abaixo. O perfil da conta deve ser concluído antes que as chaves de produção para seu aplicativo estejam disponíveis.
- Se você já preencheu o perfil da sua conta, clique na aba Configurações e continue para a Etapa 4.
-
Se o perfil da sua conta não tiver sido concluído anteriormente, role para baixo até a seção 2. Coloque seu aplicativo no ar e clique no link Conclua seu perfil de conta. Preencha as informações na página Perfil da conta e clique no botão Salvar. Retorne ao seu aplicativo conector e clique na aba Configurações.
-
Agora você deve ver uma página semelhante à mostrada abaixo. Role para baixo até a seção Terms of Service Links. Insira a URL do Contrato de Licença do Usuário Final e a URL da Política de Privacidade para seu aplicativo. Clique no botão Salvar.
-
Selecione a aba Keys e role para baixo até Production Keys. Assim que o Account Profile e os Terms of Service Links forem concluídos, as chaves de produção para seu aplicativo devem ser exibidas de forma semelhante à página abaixo. Essas chaves serão necessárias em seções posteriores desta documentação – tanto quando você gerar os tokens de acesso de produção quanto para entrar no Design Studio mais tarde. Você retornará a esta aba mais tarde.
-
Retorne à aba Dashboard. Na seção Recursos, clique no link OAuth Playground. Deixe esta janela aberta no seu navegador para que você possa retornar aqui mais facilmente mais tarde.
-
Agora você deve ver uma página semelhante à página mostrada abaixo, indicando que você está no OAuth Playground. Você precisará copiar as Chaves de Produção nos campos Chave do Consumidor e Segredo do Consumidor.
-
Retorne à janela aberta do navegador exibindo a página Intuit Developer Dashboard. Selecione a aba Keys e role para baixo até Production Keys.
- Selecione o botão Show à direita da OAuth Consumer Key para exibir a chave. Clique no botão Copy, retorne à janela do navegador exibindo o OAuth Playground e cole a chave no campo Consumer Key.
- Selecione o botão Show à direita do OAuth Consumer Secret para exibir a chave. Clique no botão Copy, retorne à janela do navegador exibindo o OAuth Playground e cole a chave no campo Consumer Secret.
-
Clique no botão Conectar ao QuickBooks no centro da página OAuth Playground.
-
Uma mensagem de aviso pop-up indica que você sairá do site. Selecione o botão Sair.
-
Agora você deve ver uma página semelhante à página mostrada abaixo. Esta é a etapa final dentro do QuickBooks para autorizar o Harmony QuickBooks Connector a acessar sua instância de produção do QuickBooks Online. Selecione o botão Connect.
-
Agora você deve ver uma página semelhante à página mostrada abaixo e exibindo Access Token, Access Token Secret e RealmId, bem como Consumer Key e Consumer Secret. Essas credenciais serão necessárias em seções posteriores desta documentação para entrar no Design Studio. Deixe esta página aberta no seu navegador, pois você precisará retornar aqui mais tarde.
Próxima etapa: Conector QuickBooks OAuth 1.0a - criar endpoint