Realizando requisições

A documentação da API Sankhya a seguir, visa demonstrar os serviços disponíveis para cada objetivo/entidade.

Tem-se aqui a explicação da regra de negócio das entidades, demonstração de uso dos serviços e detalhamento dos campos e opções disponíveis para cada entidade.

O método PUT não é utilizado em nossa API por já ser contemplado pelo método POST que pode ser utilizado para inclusão ou atualização de dados. Caso a PK (Primary Key) enviada já exista na tabela será feito UPDATE, se não existir será feito INSERT na tabela correspondente.

Exemplo de URL de requisição em Produção:
A URL de requisição possui sempre o mesmo padrão, independente do serviço a ser utilizado.

URL padrão:

https://api.sankhya.com.br/gateway/v1/[modulo]/service.sbr?serviceName=[nomedoserviço]&outputType=json

Módulos Utilizados

Abaixo são apresentados os principais módulos para uso.

MGE: O Módulo é utilizado para consulta e gravação de dados de cadastros em geral.

Exemplos de Serviços utilizados no MGE:

DatasetSP.loadRecords
CRUDServiceProvider.saveRecord
CRUDServiceProvider.loadRecords
DbExplorerSP.executeQuery

URL padrão MGE

https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=[nomedoserviço]&outputType=json

MGECOM: O Módulo Comercial é utilizado para consulta e gravação de movimentações como por exemplo consulta de pedido e criação de pedido de compra, venda entre outros.

Exemplos de Serviços utilizados no MGECOM:

CACSP.IncluirNota
CACSP.incluirAlterarItemNota
CACSP.excluirItemNota
CACSP.cancelarNota
SelecaoDocumentoSP.faturar

URL padrão MGECOM

https://api.sankhya.com.br/gateway/v1/mgecom/service.sbr?serviceName=CACSP.IncluirNota&outputType=json

Ressalta-se que os serviços mencionados acima são específicos de cada módulo, ou seja, o serviço disponibilizado no módulo MGECOM é EXCLUSIVO deste módulo, portanto não funcionará se caso o módulo setado na URL seja o MGE, assim como os serviços do módulo MGE são EXCLUSIVOS e não funcionarão no módulo MGECOM.

🚧
Atenção
Para utilização de todos os serviços, é necessário e obrigatório que seja feito o login conforme descritivo e orientação na documentação.

Como montar as requisições no Postman

Nos passos a seguir, tem-se um exemplo de chamada para iniciar o novo método de requisição via Gateway.

🚧
Atenção
Todos os exemplos abaixo se referem ao ambiente de homologação, o Playground da Sankhya. Para utilização em Produção, deve-se somente mudar a URL de apontamento.

1 - Primeiro Passo:

A - Antes de realizar qualquer chamada ao Gateway, é necessário obter um bearerToken, que será enviado em todas as requisições após a autenticação. Consulte a documentação do endpoint authenticate para obter o bearerToken e utilizá-lo nas próximas transações com o Gateway.
B - Após a chamada, recebemos o BearerToken.

2 - Segundo Passo:

A - Após receber o bearerToken, como exemplo acima, vamos chamar um serviço de Consulta de Preço de Produtos.
Devemos preencher primeiramente o Autorization com o beartoken gerado na requisição de login.

B - Após preencher o Autorization, usamos como exemplo de body da requisição, passando os parâmetros de critérios, nome do serviço, etc.

Observação: Pode ser consultado esse detalhe de chamada no link abaixo: https://developer.sankhya.com.br/reference/get_tabelapreco

833 — Exemplo de requisição para Consulta de Preços de Produtos.

C - Após preenchido o body e autorization, fazemos a chamada do serviço. Recebendo essa resposta.

Links Úteis