Configurando acessos iniciais para integração com o Sankhya via API

Para iniciar a integração com o Sankhya é bem simples, você precisará seguir os seguintes passos:

• Passo 1: (Integrador) Preencher o formulário do site Sankhya (caso ainda não tenha preenchido).
• Passo 2: (Integrador) Criar o Sankhya ID (caso ainda não tenha) através do convite recebido por e-mail.
• Passo 3: (Integrador) Acessar a Área do Desenvolvedor para cadastrar a empresa e criar a APPKEY de Integração.
• Passo 4: (Cliente) Gerar o Token na tela ‘Configurações Gateway’.
• Passo 5: (Integrador) Fazendo as requisições pela Primeira Vez.

Passo 1 INTEGRADOR solicita o cadastro para geração da Appkey no site da Sankhya.

Inicialmente, o proprietário da aplicação que será integrada ao SankhyaOm, deve se cadastrar através do site da Sankhya. Se você já preencheu o formulário em questão, aguarde o e-mail de boas vindas.

🚧

Atenção

Se você já preencheu o formulário em questão, aguarde o e-mail de boas vindas.

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.

Acesse o site parceiros Sankhya utilizando o botão abaixo:

Caso você já tenha preenchido o formulário, em até 72 horas úteis você receberá um e-mail de boas vindas.

Passo 2 Você receberá também por e-mail, um convite para cadastro do Sankhya ID

Saiba mais como completar o cadastro do Sankhya ID clicando aqui.

❗️

ATENÇÃO: Caso você não receba o convite para o Sankhya ID, significa que talvez você já tenha um usuário, neste caso, basta logar clicando aqui, use seu e-mail preenchido no formulário do passo 1.

Caso você não se lembre da senha, poderá certificar/resetar a senha acessando o endereço https://login.sankhya.com.br com ajuda deste passo a passo.

Passo 3 Com o Sankhya ID em mãos, acesse a Área do Desenvolvedor, onde você irá cadastrar sua empresa na aba 'DADOS DA EMPRESA. Depois você deve cadastrar sua aplicação na aba 'GERENCIAR SOLUÇÕES' e nessa mesma aba você irá gerar a Appkey para sua integração.

Clique aqui para acessar o passo a passo mais detalhado de criação da appkey na área do desenvolvedor..

🚧

Atenção

Se não houver nenhuma requisição na sua appkey em um período de até 4 meses, ela irá expirar e você terá que criar outra.

Passo 4 O cliente gera o Token através da tela ‘Configurações Gateway’ no SANKHYA

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.

Passo 5 Fazendo as requisições pela Primeira Vez

Antes de iniciar, entenda como funciona as Integrações via API de Serviços Gateway neste artigo.

Para iniciar as requisições, clique no botão abaixo para esclarecer as dúvidas e exemplificar as chamadas.

5.1 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. 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 para o ambiente de Produção e

150.230.86.234 e 144.22.173.39 para o ambiente de Sandbox (testes).

5.2 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.

Ou solicite via chamado na Central de Ajuda Sankhya (opção exclusiva para clientes).