API pública para Integrações

Menu: Integração > Integração

Pré-requisitos

Para liberar a tela de gerenciamento da API de Integração, o MasterSGi do cliente precisa estar com o módulo "Integração" habilitado.

Swagger

A API está documentada utilizando o projeto open source Swagger, para ter acesso a documentação basta acessar o seguinte endereço:

https://{instancia}.mastersgi.com.br/integrationapi/swagger

Na documentação disponibilizada via Swagger, é possível visualizar todos os Endpoints atuais da nossa API de Integração, o teste de consumo da API via Swagger não está disponível, sugerimos o uso do Postman (https://www.postman.com/downloads/) ou Insomnia (https://insomnia.rest/download), veja no artigo Consumo das APIs de Integração via Postman ou Insomnia como realizar os testes.

Sandbox

Também disponibilizamos para desenvolvimento e testes, um ambiente SandBox, que é uma Instância genérica do MasterSGi acessível através dos endereços:

Ambiente Geral: https://sandbox.mastersgi.com.br

APIs de Integração: https://sandbox.mastersgi.com.br/integrationapi/swagger

Para que você tenha acesso ao ambiente de Sandbox e inicie o desenvolvimento, solicite o acesso através do e-mail: suporte@octoti.com.br com o assunto: Acesso ao Sandbox do MasterSGi para Integrações.

No corpo do email, descreva sua solicitação e informando também:
- CNPJ da Software House
- Razão Social
- Email do(s) desenvolvedor(es)
- Telefone para contato
- Site da Empresa
- CNPJ de um cliente ativo de MasterSGi solicitante da Integração

Autenticação da API

Para apoiar o desenvolvimento de terceiros, principalmente no tocante das rotinas de Segurança e Autenticação da API, disponibilizamos no GitHub, de forma aberta, um projeto em C#, para apoio a cliente de consumo das APIs, o OCTO.Api.Client (https://github.com/OCTOTI/octo-api-client).

Outra forma de autenticação, é utilizar o endpoint /Autenticacao/Gera.

Finalidade

Este recurso visa liberar um acesso ao MasterSGi para que terceiros possam consultar, inserir ou alterar informações do sistema utilizando a tecnologia Rest API para realizar a comunição com API de Integração.

Operações disponíveis no MasterSGi para liberação de acesso à API de Integrações

Descrição: Nome da integração.

Filial: Permite selecionar quais filiais poderão ter os dados acessados.

Permissões: Possibilita filtrar quais APIs poderão ser acessadas.

Funcionalidade

Antes de liberar o acesso a API para sistemas externos, uma Key e um Token devem ser gerados. Tanto a Key como Token deve ser utilizados no processo de autenticação (ver exemplo em C# na OCTO.Api.Client) da aplicação que fará a o acesso às APIs.

O Token será utilizado para validar a identidade em cada requisição, assim a API permitirá a manipulação das informações liberadas de acordo com os filtros informados.

O sistema que irá consumir a API, deverá utilizar a autenticação básica, informando o Token no cabeçalho da requisição, como o exemplo a seguir:

POST https://clientes.mastersgi.com.br/integrationapi/chamados HTTP/1.1
Authorization: Basic bfbc900ae41243eda942774cf294ab72
Accept: application/json, application/xml, text/json, text/x-json, text/javascript, text/xml
User-Agent: RestSharp/105.1.0.0
Host: dellnote:810
Content-Length: 0
Accept-Encoding: deflate
Connection: Keep-Alive