Todos os parceiros terão acesso a uma appkey que é uma chave única de identificação do parceiro e sua aplicação.
Já o token, é liberado pelo cliente e servirá para liberar o acesso do integrador em seu ambiente de aplicação ( EIP SANKHYA ) e realizar a gestão de seus integradores ( cadastrar novas credenciais/inativar/ativar )
O integrador e o cliente deverão seguir os seguintes passos para habilitar as integrações:
- Passo 1: ( Integrador ) Solicitar Appkey através do site da Sankhya.
- Passo 2: ( Cliente ) Verificar se o ambiente do SankhyaOM está atualizado e habilitado o parâmetro de criar acesso com SankhyaID.
- Passo 3: ( Cliente ) Criar usuário no SankhyaOM para vincular à integração.
- Passo 4: ( Cliente ) Liberar o acesso para o integrador através da tela Configurações Gateway.
Passo 1
Inicialmente, deve ser feito o cadastramento do integrador e da sua aplicação através do site da Sankhya que será o proprietário da aplicação que será integrada ao SankhyaOm.
O integrador deve buscar um cliente piloto, não havendo disponibilizamos acesso ao Playground para iniciar o desenvolvimento da integração.
Atenção
A versão mínima para o cliente utilizar o gateway é o SankhyaOM 4.16 ou posterior
Toda a documentação de referencia já está com os apontamentos para os endpoint de Produção.
Site parceiros Sankhya
Para solicitar sua chave de integração preencha o cadastro no site parceiros Sankhya utilizando o botão abaixo:
Passo 2
Verificar se o ambiente está habilitado para criar o acesso do SankhyaID
Esta configuração é obrigatória para utilização do Gateway.
Passo 3
Caso o Integrador ainda não possua acesso ao SankhyaOM, o Cliente com acesso Admin cadastrará um usuário que será usado para a integração.
Com o intuito de aumentar a segurança das integrações com o sistema Sankhya Om, o usuário utilizado na integração deve ser classificado através da tela de usuários no campo “Tipo de usuário” como Integração que é destinado para usuários que irão realizar a integração do Sankhya Om com outra aplicação através das API’s de serviços disponíveis. Desse modo, o usuário poderá efetuar o login apenas por meio da API. {disponível na versão ≥ 4.18}
Após a criação do usuário, devem ser concedidos os acessos as telas que estão vinculadas as tabelas que serão utilizadas na integração. A configuração é feita através da tela Acessos no SankhyaOm, e para consultar os acessos que devem ser concedidos clique aqui.
Na tela Usuários do Sankhya, tem se a opção de enviar um convite do SankhyaID utilizando o e-mail do integrador. Necessário preencher o campo senha com no mínimo 6 dígitos e cadastrar o grupo de acesso.
Tela de Usuários
Enviando convite para criar acesso
Aguardando login do usuário
Caso o Integrador possua já o acesso com e-mail e senha do SankhyaID, deverá usar o mesmo para autenticação da API.
Atenção
Caso o Integrador não tenha a senha, não se recorde da mesma ou até mesmo não saiba se ainda esse acesso, poderá certificar/resetar a senha acessando o endereço https://login.sankhya.com.br.
Passo 4
O cliente deve cadastrar a integração que deseja liberar através da tela Configurações Gateway em seu SankhyaOM para obter o token seguindo o passo a passo à seguir:
Após obter o token, basta disponibilizar para o integrador para acesso ao seu ambiente.
Fazendo as requisições pela Primeira Vez
Para iniciar as requisições, clique no botão abaixo para esclarecer as dúvidas e exemplificar as chamadas.
Inclusão de IP´s no Firewall devido chamada do Gateway
O firewall do Windows, por padrão, bloqueia conexões de aplicativos com a Internet e portas para evitar problemas de segurança.
O firewall do Windows, por padrão, bloqueia conexões de aplicativos com a Internet e portas para evitar problemas de segurança. Mas isso pode comprometer o funcionamento das nossas API´s que precisam de portas específicas para se conectar a um servidor remoto.
Em alguns testes de autenticação com integradores, identificamos que foram bloqueadas as requisições das APIs pelo firewall. Nesses casos, tiveram a necessidade de incluir os dois IP´s do nosso servidor no firewall para evitar bloqueios.
Atenção
Caso tenha algum problema de bloqueio, gerando um time-out da requisição, orientamos inserir os dois ip´s, informados abaixo, no firewall a fim de evitar bloqueios.
144.22.228.211 e 144.22.217.141
Realizando requisições - Documentação Técnica
A documentação técnica da API apresenta informações importantes para uso dos serviços, como lista de serviços disponíveis, padrão de corpo da requisição e corpo do retorno. Essa documentação está dividida em duas seções, uma voltada para XML e outra para JSON.
Mapeamento de serviços
Nem todos os serviços disponíveis estão documentados, porém é possível identificá-los usando a ferramenta de desenvolvimento do navegador confira o procedimento no artigo Como mapear serviços
Como tirar dúvidas?
Para tirar dúvidas e compartilhar informações, use a sala API de Integração da comunidade Sankhya Developer.