API de Serviços Gateway

Na era da interconectividade, a integração de sistemas é um pilar essencial para a eficiência empresarial. Destacaremos aqui os requisitos essenciais para integrar uma solução aditicional à plataforma de gestão Sankhya com sucesso. Será apresentado desde a conformidade com padrões estabelecidos até a mitigação de riscos, exploraremos como adotar uma abordagem padronizada pode simplificar processos, promover a escalabilidade e garantir a segurança dos dados. Descubra as vantagens inegáveis e os perigos potenciais de ignorar esses princípios fundamentais de integração.

Mas, quais são os requisitos essenciais para a integração com a Plataforma Sankhya? O processo de integração é composto por autenticação e requisições autorizadas, facilitadas através de nossa API Gateway. A imagem a seguir oferece uma ilustração clara do funcionamento desse processo.

Para integrar com a plataforma de gestão SankhyaOm, é imprescindível utilizar a API Gateway, responsável por encaminhar todas as requisições para as respectivas plataformas de gestão SankhyaOm. Mas quais são os pré-requisitos para realizar essa integração? Vamos explorar os pontos fundamentais para o primeiro acesso que é a autenticação do acesso. Aqui estão os requisitos essenciais para autenticar e fazer requisições usando a API Gateway:

• AppKey: A AppKey (Chave de Aplicação) é única e identifica a aplicação integrada e o parceiro integrador em todas as transações realizadas via API Gateway. É crucial observar que a AppKey é estritamente exclusiva e intransferível, portanto, não deve ser compartilhada com terceiros. Esta chave de aplicação está disponível para aquisição no portal Sankhya designado para parceiros integradores.
• SankhyaID: O SankhyaID é uma maneira segura de fazer login no ecossistema Sankhya (SankhyaOm, Universidade, Portal do Cliente, entre outros), consistindo em um e-mail válido e uma senha. O parceiro integrador deve criar um SankhyaID para autenticação via API Gateway.
• Token: O cliente deve conceder acesso ao parceiro integrador através do SankhyaOm. Essa concessão de acesso implica em autorizar a aplicação do parceiro, gerando assim um token. Esse token é a chave que conecta a aplicação do parceiro integrador à Plataforma de Gestão SankhyaOm utilizada pelo cliente.
• Camada de Autorização: Toda transação realizada através da API Gateway passa por uma camada de autorização integrada à plataforma de gestão SankhyaOm. Para implementar essa camada, durante a criação do token, é necessário vincular um usuário existente no SankhyaOm. As permissões de acesso concedidas à aplicação do parceiro integrador na plataforma SankhyaOm estão ligadas a esse usuário utilizado na criação do token. Isso significa que, para liberar ou restringir acessos à aplicação do parceiro integrador, basta configurar as permissões desse usuário.

Para que este fluxo de integração seja possível, é crucial que o acesso ao SankhyaOm do cliente esteja autorizado para a API Gateway, independentemente da localização da infraestrutura utilizada para fornecer o SankhyaOm, seja ela interna ou externa.

A imagem a seguir exemplifica o funcionamento prático do processo:

Com isso, torna-se viável efetuar requisições para obter e enviar dados à plataforma de gestão SankhyaOm, fazendo uso da API Gateway, o meio recomendado e oficial pela Sankhya. Agora, vamos analisar de forma clara os principais benefícios de realizar integrações dessa maneira:

• Segurança e compliance nas integrações externas: Através da aplicação de liberações de acesso e camadas de autorização com acessos específicos, as integrações utilizando a API Gateway garantem maior segurança da informação.
• Simplificação das integrações de parceiros com a plataforma: Por meio de um portal dedicado à documentação das APIs e aprimoramentos em serviços especializados, os parceiros integradores contam com um suporte mais robusto para desenvolver suas integrações.
• Integrações escaláveis: Com o crescimento substancial da API Gateway, nossos parceiros e clientes têm acesso a um ecossistema robusto com amplas possibilidades. De um lado, nossos clientes se beneficiam de diversas oportunidades para aprimorar seus processos e impulsionar o crescimento de seus resultados. Por outro lado, os parceiros integradores têm à disposição uma base de clientes que podem aproveitar plenamente suas soluções, totalmente integradas com a plataforma de gestão SankhyaOm.

Agora que examinamos os pré-requisitos e vantagens de usar a API Gateway para integrações, vamos agora explorar as desvantagens de não adotá-la como o padrão de integração.

Vamos abordar a integração direta com o Banco de Dados. Este tipo de integração ocorre quando sistemas de terceiros acessam diretamente o banco de dados. Isso implica em não utilizar as regras de negócio existentes no ERP para acessar, incluir, modificar ou excluir dados. Um exemplo prático é o processo de inclusão de um pedido de venda, no qual diversas configurações da empresa impactam esse lançamento. Ao realizar essa inclusão diretamente no Banco de Dados, essas regras podem ser ignoradas. Além disso, essa abordagem torna todas as informações do banco de dados, como folha de pagamento, faturamento e fluxo de caixa, totalmente acessíveis.

Dito isso, apresentamos de forma simples e objetiva as principais formas de integração não aceitas e fora de compliance:

• Conexão direta com banco de dados;
• Uso de APIs diretamente, sem a utilização de API Gateway (AppKey);
• Qualquer outra forma de integração que não utilize o API Gateway e AppKey.

Exploramos os requisitos e procedimentos essenciais para integrar uma solução à plataforma de gestão Sankhya, desde a autenticação até a camada de autorização na API Gateway, enfatizando a importância de padrões e segurança. Destacamos os benefícios da integração via API Gateway, como a segurança e a simplificação do processo para parceiros e clientes, além da escalabilidade. Também discutimos as desvantagens da integração fora do padrão API Gateway, como a integração direta com o banco de dados, ressaltando a falta de adesão às regras de negócio do ERP e a exposição de informações sensíveis. Em resumo, agora temos uma visão abrangente dos requisitos e implicações das integrações, enfatizando a importância de adotar a API Gateway como padrão.

Credenciamento do Parceiro | SankhyaID | Documentação da API | Liberação de Ambientes/Gerar Token |
Como Mapear Serviços Boas Práticas de Integração | Status do Gateway | Artigos Sankhya |
Comunidade para Dúvidas