Como configurar a integração com o Omie?

Nesse artigo orienta como configurar a integração entre o Sankhya Despesas e o Omie, incluindo a conexão, configuração dos templates, webhook, sincronização de usuários e acompanhamento de erros e histórico.

ÍNDICE

• Quem pode configurar a integração?
• Como conectar o Omie ao Sankhya Despesas?
  • Como encontrar o APP_KEY e o APP_SECRET no Omie?
• Como configurar os templates?
• Como configurar o webhook do Omie?
• Como cadastrar a tag Espresso no Omie?
• Como funciona a sincronização de usuários?
• Como consultar erros de integração?
• Como consultar o histórico de ações da integração?
• Informações importantes
• Perguntas frequentes
  • Quem pode configurar a integração com o Omie?
  • Onde encontro o APP_KEY e o APP_SECRET?
  • O que fazer se o teste de conexão apresentar erro?
  • Para que serve o webhook?
  • Qual tag deve ser cadastrada no Omie?
  • Quais eventos devem ser configurados no webhook?
  • Onde posso consultar os erros da integração?
  • Onde posso acompanhar as ações realizadas na integração?

Quem pode configurar a integração?

A configuração da integração está disponível para usuários com perfil de Administrador ou Financeiro.

Como conectar o Omie ao Sankhya Despesas?

1. Acesse Integrações > Integrações para ERPs.

2. Localize o Omie e clique em Conectar.

3. Informe as credenciais de integração do Omie:

   • APP_KEY;

   • APP_SECRET.

Como encontrar o APP_KEY e o APP_SECRET no Omie?

1. Acesse o Omie.

2. Na tela principal, acesse Meus aplicativos.

3. Clique na engrenagem do aplicativo desejado.

4. Clique em Resumo do app.

5. Copie o APP_KEY.

6. No campo do APP_SECRET, clique em Exibir e copie a chave.

7. Retorne ao Sankhya Despesas.

8. Cole as credenciais nos respectivos campos.

9. Clique em Testar conexão.

Após a validação das credenciais, a integração estará conectada. Essa informação poderá ser confirmada pela indicação "Conectado" na tela.

Como configurar os templates?

1. Após validar as credenciais, clique em Configurar templates.

2. Serão apresentados os templates disponíveis para configuração.

3. Escolha o template que deseja configurar.

4. Clique em Configurar.

A configuração do template selecionado seguirá as etapas específicas apresentadas na plataforma.

Como configurar o webhook do Omie?

O webhook permite que as informações entre o Omie e o Sankhya Despesas sejam sincronizadas em tempo real.

Para realizar a configuração:

1. Acesse o Omie Developer.

2. Selecione o aplicativo que está sendo integrado.

3. Clique em Adicionar novo Webhook.

Também é possível acessar a opção Webhook diretamente pela configuração da integração no Sankhya Despesas.

4. No campo Endpoint, insira:

https://espresso-barista-production.herokuapp.com/api/v1/webhooks/omie/users

5. Marque os seguintes eventos:

• Cliente/Fornecedor.Alterado

• Cliente/Fornecedor.Excluido

• Cliente/Fornecedor.Incluido

6. Clique em Salvar.

Como cadastrar a tag Espresso no Omie?

É necessário cadastrar uma tag com o nome "Espresso" no Omie para que a sincronização dos usuários seja realizada corretamente. Após realizar o cadastro da tag no Omie, digite ela no campo dentro do Sankhya Despesas.

Como funciona a sincronização de usuários?

Após concluir a configuração:

1. Ao cadastrar um Cliente ou Fornecedor no Omie, informe os dados obrigatórios, como nome, e-mail e a tag Espresso.

2. Sincronize a integração no Sankhya Despesas.

3. Acompanhe a importação dos usuários pela plataforma.

Como consultar erros de integração?

Caso um cadastro seja realizado com alguma informação obrigatória ausente ou ocorra algum erro durante a integração, é possível consultar os registros na página de Erros de Integração do Sankhya Despesas.

Nessa seção, são apresentados detalhes dos erros relacionados à integração de usuários com o ERP, como:

• Nome;

• E-mail;

• Identificador no ERP;

• Detalhes do erro.

Para cada erro, também é possível:

• Arquivar o erro;

• Consultar o Log;

• Consultar os Eventos relacionados.

Como consultar o histórico de ações da integração?

Na aba Histórico de Ações, é possível acompanhar as atividades realizadas na integração.

Cada registro apresenta informações sobre a ação realizada, permitindo acompanhar alterações e tentativas de sincronização, incluindo dados como ação, usuário e data.

Informações importantes

• É necessário possuir perfil Administrador ou Financeiro para configurar a integração.

• O APP_KEY e o APP_SECRET são obtidos diretamente no Omie.

• A tag Espresso deve ser cadastrada no Omie para a sincronização de usuários.

• Para que um usuário seja sincronizado corretamente, é necessário cadastrar as informações obrigatórias e associar a tag Espresso.

• O webhook deve estar configurado com os eventos indicados para que as informações sejam sincronizadas corretamente.

Perguntas frequentes

Quem pode configurar a integração com o Omie?

Usuários com perfil de Administrador ou Financeiro podem realizar a configuração.

Onde encontro o APP_KEY e o APP_SECRET?

As credenciais ficam no Omie, em Meus aplicativos > engrenagem do aplicativo > Resumo do app.

O que fazer se o teste de conexão apresentar erro?

Verifique se o APP_KEY e o APP_SECRET foram copiados corretamente do Omie. Após conferir as credenciais, tente realizar o teste de conexão novamente.

Para que serve o webhook?

O webhook permite que determinadas alterações realizadas no Omie sejam comunicadas ao Sankhya Despesas, contribuindo para a sincronização das informações.

Qual tag deve ser cadastrada no Omie?

A tag deve ser cadastrada com o nome Espresso.

Onde posso consultar os erros da integração?

Os erros podem ser consultados na página de Erros de Integração, onde também é possível visualizar o log e os eventos relacionados.

Onde posso acompanhar as ações realizadas na integração?

Na aba Histórico de Ações, é possível consultar as atividades e tentativas de sincronização registradas pela integração.