Integração API

Versão 10.003.025

Com o intuito de integrar outros sistemas ao ERP Solution, foi desenvolvido a API (Application Programming Interface). A API possibilita que sistemas de terceiros realizem ações dentro do ERP, tais como incluir clientes, abrir pedidos, consultar vendas, entre diversas outras ações.

Integração

Para utilização da API, é necessário que uma Software House (empresa que desenvolve o sistema) esteja devidamente autorizada, ou seja, que ela esteja cadastrada e vinculada à uma empresa/cliente da Solution.
Chamamos este vínculo de Integração. Cada Integração é vinculada a uma única empresa, ou seja, caso uma Software House esteja integrada com mais de uma empresa do mesmo grupo, existiram “n” Integrações, uma para cada empresa.
Através da rotina de integrações, acessada em:

Configurações > Integração API > Integrações (2877)

Pode-se consultar as integrações previamente cadastradas pela Solution.

Através do botão “Sincronizar”, pode-se fazer a re-sincronização das integrações.
Este processo serve para casos onde houve erro na sincronização inicial, corrigindo o sistema em possíveis casos de inconsistência.

Importante! Este processo é executado somente para a empresa logada.

Configuração de Integração

Nas configurações da integração são definidas informações que serão utilizadas como padrão em alguns processos específicos.
Por exemplo, um sistema de terceiros (e-Commerce) possui configurado que na “integração X” será utilizada a operação de “venda” e a política de prazo “à vista”. Desta forma, o ERP “entende” que deverá ser utilizado estas definições quando for feita uma solicitação de cálculo de preço de venda desta integração.
Quando o sistema estiver vinculado a uma integração que não possui configuração definida (ainda usando o exemplo anterior), a integração poderá escolher a operação e política de prazo para o cálculo de preço de venda manualmente.

Na rotina de integrações, acessada em:

Configurações > Integração > API > Integrações (2877)

Selecionando a integração e clicando no botão “Configurações”, será aberta a rotina de Configurações de Integração (2878).

Para incluir novas configurações, deve-se clicar no botão “Inserir” (símbolo +).
Não é possível incluir uma configuração que tenha a mesma combinação de “Integração”, “Tipo” e “Filial”. As informações passíveis de definição podem variar conforme o “Tipo” da Configuração.
Para consultar uma configuração, deve-se clicar no botão “Mostrar” (símbolo da lupa). Nesta tela também é possível realizar a exclusão de uma configuração, através do botão “Excluir”.
Para alterar uma configuração, deve-se clicar no botão “Modificar” (símbolo do lápis). Não é possível alterar os campos de “Integração” e “Tipo” de uma configuração.

Chaves de Usuário

Toda comunicação de um sistema de terceiro com o ERP será feita utilizando usuários existentes e autorizados dentro do sistema.

Para que um usuário esteja autorizado, é necessário que ele possua uma chave configurada para a Integração. Cada usuário terá uma chave única por integração.
A chave é importante pois, com ela, não há a necessidade que o terceiro tenha conhecimento da senha pessoal do usuário.
Para ter acesso às configurações das chaves deve-se acessar:
Configurações > Cadastros > clicar no botão “Modifica” (símbolo de lápis), e acessar a aba “Integrações”. Nesta aba é possível incluir novas chaves, atualizar e excluir chaves já existentes.

Para incluir novas chaves, deve-se clicar no botão “Inserir” (símbolo +). Na janela aberta, deve-se informar a Integração ao qual a chave será gerada.
Para atualizar chaves existentes, deve-se clicar no botão “Atualizar”.
Esta ação fará com que a antiga chave pare de ser aceita pelo sistema, cabendo ao usuário repassar a nova chave a Software House.
Para excluir chaves existentes, deve-se clicar no botão “Excluir” (símbolo de lixeira). Esta ação fará com que a antiga chave para de ser aceita pelo sistema.