API de Serviços Gateway

Introdução e Objetivos Gateway

A API é usada para integrar a plataforma Sankhya com outros sistemas para permitir a troca de informações. Ela também pode ser usada para automatizar buscas e cadastros em vários módulos da plataforma.

O Gateway, como o nome diz, é um portão de acesso, que se propõe a gerenciar as requisições recebidas e redirecionar para os serviços correspondentes, facilitando a integração de serviços externos e contribuindo no processo de monitoramento e garantia de segurança no uso das APIs Sankhya.

Nossa missão: Otimizar a plugabilidade da plataforma, trazer maior nível de compliance, governança e reduzir o tempo das implantações que requerem integração com o ecossistema de parceiros.

Objetivos:

• Aumento do controle sobre as integrações;
• Segurança e compliance sobre as integrações externas;
• Facilitação das integrações de parceiros com a plataforma;
• Autonomia para a construção de integrações, com escalabilidade;
• Redução do tempo de implantação quando houverem integrações;

As API´s são baseadas em chamadas HTTP ou HTTPS, do tipo POST e GET, com corpo no formato JSON ou XML. Portanto, qualquer sistema que possuir capacidade de realizar uma chamada HTTP convencional poderá fazer uso dos diversos serviços fornecidos pela API.

📘

Importante

Entidade é um termo utilizado para definir tudo que pode ser cadastrado, editado, consultado e excluído no sankhya. Um exemplo seria a entidade Produto, um produto pode ser cadastrado, editado, consultado ou excluído.

Cenário Atual x Cenário Novo

Atualmente aplicações terceiras se integram ao SankhyaOM através das APIs ou até mesmo via banco de dados em integrações antigas.

Nesse cenário, não conseguimos agregar toda a segurança desejada. Com isso, tivemos uma mudança que visa beneficiar e garantir sucesso com confiança nas consultas passando pelo Gateway.

📘

Importante

Antigamente apontava-se para o ambiente do Cliente para consulta e retorno de informações. Agora, o que mudará é que teremos o apontamento diretamente para o Gateway que irá conhecer cada aplicação e fazer o correto direcionamento.

Cenário atual

Novo cenário

No cenário novo, as integrações já estão passando pelo Gateway e utilizando-se de uma URL única que centraliza as requisições e agrega uma camada de segurança, identificando e validando as chaves.

Status do Gateway

Para verificar se o Gateway está disponível e estável acesse o status através do botão abaixo:

Dúvidas frequentes

Ainda tem dúvidas de como funciona a API de Serviços? Consulte no botão abaixo a nossa FAQ com as Perguntas Frequentes e confira se já existe uma resposta para sua pergunta.

Como tirar dúvidas?

Para tirar dúvidas e compartilhar informações, use a sala API de Integração da comunidade Sankhya Developer.