A partir de quando devo passar a enviar a Appkey?
O que é a chave de acesso?
A chave de acesso ou AppKey consiste em um código que identifica a empresa que está integrando ao EIP da Sankhya, facilita o processo de suporte e aumenta a segurança durante a integração.
O que é o token de acesso?
O token de acesso é um código que identifica qual o cliente que o parceiro integrador deseja acessar. O token é gerado na tela Configurações Gateway no Sankhya Om versão 4.16 em diante.
Em quais cenários são utilizadas as chaves de acesso?
Sempre que for necessário integrar a algum EIP Sankhya utilizando as APIs disponíveis, deve-se enviar as chaves de acesso no header da requisição de login.
Devo utilizar a AppKey para botões de ações, personalizações e afins?
Neste momento não. Estamos em fase de desenvolvimento do processo que irá permitir a identificação das ações realizadas através das personalizações e extensões, logo será necessário o envio de uma AppKey nestes processos, por hora apenas ao utilizar as APIs de Serviços e a API da Sankhya será necessário o envio da chave no header das requisições.
Para clientes que utilizam o modelo on premise é necessário o uso do endpoint do gateway com AppKey e token?
Sim, será necessário o uso de AppKey e token em todas as integrações, independente de ser cloud ou on premise.
Terei direito a uma chave gratuita para as integrações próprias da minha empresa?
O registro de AppKeys em ambiente de testes não gera custos para cliente ou parceiros.
Qual documentação devo utilizar para o desenvolvimento das integrações?
Recomendamos que para todas as integrações, utilizem a documentação disponível no Developer que pode ser acessada através do link https://developer.sankhya.com.br/reference/api-de-integra%C3%A7%C3%B5es-sankhya
Conseguirei saber quais foram os registros atualizados recentemente através da API?
A API permite que sejam aplicados filtros durante as requisições de busca, logo caso a entidade consultada possua um parâmetro compatível a este processo será possível realizar esta busca. Todas as nossas apis são responsivas e não temos um serviço de retorno ativo por parte do Sankhya.
Caso minha empresa utilize um sistema de uma empresa terceira que não possui acordo comercial com a sankhya este sistema irá parar de funcionar?
A princípio não haverá prejuízos no funcionamento das integrações terceiras, porém recomendamos que seja solicitado a homologação desta empresa, a homologação pode ser solicitada pelo e-mail: [email protected]. E também será necessário que a empresa terceira se atualize para efetuar a integração com a Sankhya, solicitando também uma APPkey para a mesma.
Como faço para filtrar por data e hora em uma entidade na API de integração Sankhya ?
Deve ser verificado se o campo que se deseja filtrar, ele já existe no banco de dados do ERP. Pois caso seja um campo adicional e esteja usando o banco do ERP da Sankhya, não será possível efetuar consulta com filtro.
O XML deve ser formatado antes de ser enviado?
Não. Nos exemplos deste manual o XML está formatado apenas para facilitar o entendimento. No uso real deve-se enviar o XML sem espaços ou quebras de linhas desnecessários, apenas aqueles que fazem parte do conteúdo de campos texto devem ser preservados (geralmente dentro de um CDATA).
Qual API ou ferramenta de conexão devo utilizar ?
Os serviços podem ser utilizados por qualquer linguagem que suporte chamadas HTTP/HTTPS. Os exemplos contidos neste manual foram testados usando um complemento do Google Chrome chamado 'Postman Rest Client'.
No exemplo em Java disponível no arquivo Exemplo-RestCall-SW.zip, fazemos uso de uma API própria que facilita a chamada dos serviços em programas Java. Esse exemplo pode ser usado como ponto de partida para outras linguagens.
Como saber o nome das entidades de dados e suas respectivas ligações e campos ?
O local mais apropriado para se obter essas informações é no próprio sistema Sankhya-OM, na tela Dicionário de dados. Nesta tela é possível obter informações sobre tabelas, campos, ligações, domínio de campos (lista de possíveis valores, nulabilidade, tipo de dados), etc. .
Qual é o padrão de nomes usado pela plataforma Sankhya?
Todos os nomes de campos e entidades de dados são sensíveis a caixa baixa/alta (case-sensitive).
- Nomes de campos devem ser escritos sempre em CAIXA ALTA, sem acentos nem cedilhas.
- Nome de entidades de dados seguem o padrão "Camel-case", onde o primeiro caractere de uma palavra é sempre em maiúsculo, o resto é em minúsculo.
- Não há acentos nem cedilha e não há separação de palavras por espaço, exemplo: TipoOperacao (nome da entidade Tipo de Operação)
Todo cliente precisa ter appkey ou somente para os clientes que possuem integrações gerenciadas por terceiros?
Sim, todo cliente que possui integração com parceiros integradores ou gerenciadas internamente, precisa ter appkey. O que vai diferenciar é a questão do token. Caso tenha uma integração feita por terceiros, o cliente deve informar o token para o parceiro integrador para o mesmo acessar a aplicação do cliente.
A central de certificação vai controlar de alguma forma o acesso de informação da base pelo integrador?
Sim. Hoje já está em andamento um projeto (CAMADA DE AUTORIZAÇÃO) onde apenas o que o cliente liberar (financeiro, comercial etc) será acessado pelo integrador.
A obrigatoriedade do gateway significa que o Fast Service e toda a linha MGE vão parar de funcionar em janeiro/24?
Não. Apenas as integrações ESPECIALISTAS que não estiverem no padrão.
Aplicações desenvolvidas como micro serviços que não utilizam as Api's Sankhya também serão normalizadas?
Se é um micro serviço que não usa a API Sankhya e também não escreve nada no banco de dados, ele não precisa ser normalizado.
Se é um micro serviço que escreve no banco de dados da Sankhya diretamente ele precisa ser normalizado.
Como o Gateway irá para todos os clientes?
O Gateway é uma solução fora do SankhyaOM que está em produção desde
Setembro/22. Todos os clientes que estão nas versões à partir da 4.16 já possuem a
possibilidade de cadastrar seus ambientes e disponibilizar para os parceiros especialistas
Como vai ser realizado este rastreio e mudança dos clientes já implantados para o gateway?
Este levantamento está sendo realizado onde conseguimos visualizar os clientes que já
estão no modelo de governança ( novos clientes ), clientes legados que não possuem
integrações, clientes legados que possuem integrações fora do padrão e clientes legados que possuem integrações dentro do novo padrão do Gateway. Esta mudança para os clientes legados será realizado de forma gradativa com muito cuidado para não gerar nenhum problema na operação dos clientes e o calendário das mudanças será publicado para toda a rede e comunicado para clientes, unidades e parceiros.
Existe alguma definição sobre geração de incremento na mensalidade do cliente em função da conexão dele com outras soluções via gateway?
Estamos estudando a melhor forma para atender necessidades dos clientes, dos parceiros e da Sankhya.
Mas se o cliente antigo não quiser pagar estes ajustes para a nova plataforma, como vai funcionar ?
O cliente ficará fora do modelo de governança orientado pela Sankhya. Ele será totalmente responsável por seu ambiente e deverá assinar um termo sobre consciência dos riscos que ele estará sujeito.
Para nós parceiros, existe algum portal onde é possível acompanhar informações de telemetria?
Neste momento, a telemetria não está disponibilizada para os parceiros.
Estudamos a possibilidade de disponibilizar essas informações aos parceiros em um próximo momento.
Quais as próximas evoluções do Gateway? SSO?
Iremos evoluir a autenticação através do SankhyaID, evoluir o Webhook para contemplar mais segmentos, disponibilizar a vitrine de parceiros e o portal do integrador.
Qual o controle do Cliente em relação ao que permite o integrador acessar informações da base?
exemplo: pode acessar a TGFCAB mas não pode a TGFLIV.
Há um projeto sobre autorizações e acessos onde apenas o que o cliente liberar ( financeiro, comercial etc ) será acessado pelo integrador.
Em casos de problemas de performance ou até sobrecarga do Gateway, a responsabilidade de suporte é da indústria sankhya?
A responsabilidade da estabilidade do Gateway é da Sankhya. A responsabilidade da qualidade da integração é do autor da integração ( empresa especialista ou próprio cliente )
Será possível vincular o gateway em uma base local/vm e etc ?
É necessário acesso do Gateway à base local por http/https. Em casos em que a rede é protegida por firewall, faz-se necessária a liberação dos IPs 144.22.228.211 e 144.22.217.141
Terá algum local para sabermos sobre oscilações no gateway?
Sim, no futuro será construído o portal de integração onde todas as informações necessárias para os autores serão disponibilizadas.
Toda e qualquer requisição passará pelo gateway antes de chegar na aplicação?
Sim, este é o modelo oficial de integração.
Como será a Monetização entre o cliente e o fornecedor a partir do Gateway?
Atualmente nosso modelo segue a mesma característica do modelo comercial de
propostas da Sankhya . Modelo SAAS (Setup e Mensa ) enquanto o cliente está ativo
em nossa base e do parceiro. O % de comissionamento é avaliado de acordo com a
solução e também avaliamos alguns critérios para negociação deste %, a robustez da
integração uma vez que é de responsabilidade total do parceiro e ticket médio do produto.
Como ficam os parceiros não oficiais que estão atendendo a carteira? Vai barrar as integrações com eles?
Sim, serão barrados. Todos os integradores deverão adequar as suas soluções.
Para que o integrador continue comunicando com a Sankhya, o mesmo deverá entrar no novo modelo de governança.
Serão homologados pessoas físicas?
Não. Apenas empresas 'PJ'.
Não consigo visualizar minhas integrações e tokens na tela Configurações Gateway, como proceder?
Nessa situação pode ser acionada nossa equipe através do e-mail [email protected]. Este problema pode ocorrer caso tenha alterado o registro do banco de dados ou tenha um cadastro muito antigo de token.