documenter.getpostman.com Open in urlscan Pro
2606:4700:4400::6812:2196  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Public


Documentation Settings

ENVIRONMENT
Documentação Pública

LAYOUT
Double Column

LANGUAGE
cURL - cURL



Documentação API Siclope - TECNORED
Introduction
Variáveis utilizadas nesta documentação
Envio de parâmetros de forma discreta
Métodos de autenticação na API
Retorno de erros
Mapa de relacionamentos entre tabelas
Endpoints de gravação
Como utilizar esta documentação no Postman®
Atualização de dados incremental
Simulação de alterações
Autorização de acesso
Login na API
EndPoints


DOCUMENTAÇÃO API SICLOPE - TECNORED

Este documento é privado, Todos os direitos reservados. É proibida a cópia,
armazenamento em arquivo digital ou qualquer forma ou meio de divulgação do
conteúdo desta publicação, seja de modo eletrônico, mecânico, em fotocópias,
registros ou por qualquer outro meio, sem prévia autorização por escrito da
ERPLAN.

O SICLOPE – Sistema Integrado de Controle de Operações – é um software
desenvolvido dentro do modelo de SGI (Sistema de Gestão Integrada) para gerir
especificamente processos das áreas de Saúde e Segurança do Trabalho, Meio
Ambiente e Qualidade. Diferentemente da maioria das soluções encontradas no
mercado – que foram adaptadas de outros setores, o SICLOPE foi pensado e criado
do zero por profissionais que viveram os desafios das áreas de SSMAQ por
décadas.

Esta API só pode ser usada por usuários autorizados cujas credenciais de acesso
são fornecidas diretamente aos clientes da ERPLAN. Esta documentação
especificamente trata da integração dos dados do Siclope.

Os acessos de leitura existentes permite uma integração segura com softwares de
terceiros como Power BI®, SAP®, soluções de Data Lake ou qualquer software que
consiga conversar com uma API RESTFul padrão.

Há também acessos de gravação que podem ser utilizados para inserir dados na
base do Siclope a partir de outros sistemas.

Os parâmetros enviados podem ser pelos métodos GET, POST ou DELETE, dependendo
da ação a ser tomada.

Mais informações

--------------------------------------------------------------------------------


VARIÁVEIS UTILIZADAS NESTA DOCUMENTAÇÃO

Algumas variáveis que estão exemplificadas nesta documentação de API do Siclope
devem ser substituídos pelos valores corretos na utilização.

Se editado no software Postman® é possível determinar estas variáveis de
ambiente para testes da API.

View More

Variável Descrição API-KEY Hash fornecido para Erplan para acesso controlado da
API. API-TOKEN Hash fornecido após login válido por uma sessão user Nome de
usuário fornecido pela Erplan password Senha criptografada com algoritmo MD5
EMPRESA Nome da empresa para ser mostrada nos títulos key Para API somente
leitura, fornecido no cadastro de um usuário de API no Siclope, para não
precisar logar a cada sessão token Fornecido junto com o key, token fixo que
será usado nas consultas GET paises Nome do mais alto nível de hierarquia da
empresa (Países), no plural Pais Nome do mais alto nível de hierarquia da
empresa (Pais), no singular negocios 2º Nível de hierarquia (Negócios), no
plural Negocio 2º Nível de hierarquia (Negocio), no singular unidades 3º Nível
de hierarquia (Unidades), no plural Unidade 3º Nível de hierarquia (Unidade), no
singular departamentos 4º Nível de hierarquia (Departamentos), no plural
Departamento 4º Nível de hierarquia (Departamento), no singular setores 5º Nível
de hierarquia (Setores), no plural Setor 5º Nível de hierarquia (Setor), no
singular unidades 6º Nível de hierarquia (Unidades), no plural Unidade 6º Nível
de hierarquia (Unidade), no singular areas 7º Nível de hierarquia (Áreas), no
plural Area 7º Nível de hierarquia (Area), no singular subareas 8º Nível de
hierarquia (Subáreas), no plural Subarea 8º Nível de hierarquia (Subarea), no
singular gestoes Nome utilizado na empresa (Gestões) indicadores Nome utilizado
na empresa (Indicadores) solicitantes Nome utilizado na empresa (Solicitantes)
Solicitante Nome utilizado na empresa (Solicitante) origens Nome utilizado na
empresa (Origens) normas Nome utilizado na empresa (Normas)


ENVIO DE PARÂMETROS DE FORMA DISCRETA

As consultas por GET são bem fáceis de usar, mas tem um problema: a URL
informada os parâmetros da consulta ficam visíveis para todos, como por exemplo:

Plain Text


Exemplo de envio de variáveis por GET:
[URL da API fornecido pela ERPLAN]/Transfer/API/Planos?api-token=XXXX&id=YYYY

Apesar da API aceitar este tipo de consulta, é mais seguro e recomendado enviar
as informações no header da requisição GET, enviando como variáveis.

Exemplo em XHR usando Ecmascript puro:

Plain Text


var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});
xhr.open("GET", "[URL da API fornecido pela ERPLAN]/Transfer/API/Planos");
xhr.setRequestHeader("api-token", "XXXXX");
xhr.setRequestHeader("id", "YYYYY");
xhr.send();

É o equivalente à URL com as variáveis expostas.

--------------------------------------------------------------------------------


MÉTODOS DE AUTENTICAÇÃO NA API

A API do Siclope foi prevista para somente retornar dados se o usuário utilizado
para a consulta é autorizado previamente no Siclope a fazê-lo.

Por padrão, todas as consultas e gravação de dados podem ser feitas utilizando o
EndPoint de Login, pelo qual são enviados os dados de API-KEY fixa, além do
usuário e senha. Um login bem-sucedido retornará um API-TOKEN, que deverá ser
enviado em todas as demais consultas da API, no Header da requisição, como
Authorization Bearer. Desta forma, o mesmo método pode ser usado para consultas
somente leitura (GET) ou de gravação (POST).

Mas esse não é o único método de autenticação aceito pela API do Siclope, embora
seja o mais recomendado. Dependendo da configuração do usuário da API cadastrado
no Siclope, é possível não passar pelo processo de login, consequentemente sem a
geração de um API-TOKEN, configurando para geração de token e key.


MÉTODO 1: AUTHORIZATION BEARER (OAUTH 2.0) - GET, POST E DELETE

Após o login, o API-TOKEN é fornecido e deverá ser enviado no Header
Authorization Bearer em todas as requisições seguintes. É o método mais seguro
para consultas de registros no banco de dados e também é o único aceito para
gravação de dados na API do Siclope.

É necessário que o usuário da API cadastrado no Siclope esteja configurado como
API-KEY por sessão.

Exemplo de envio de consulta GET com Authorization Bearer:

Plain Text


var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});
xhr.open("GET", "[URL da API fornecido pela ERPLAN]/Transfer/API/Planos");
xhr.setRequestHeader('Authorization', 'Bearer •••••••');
xhr.setRequestHeader("id", "YYYYY");
xhr.send();


MÉTODO 2: VARIÁVEIS KEY E TOKEN - APENAS CONSULTAS GET

Sem precisar logar na API, todas as consultas GET podem ser realizadas enviando
duas variáveis na URL da consulta: key e token.

Para que este método seja aceito, o usuário de API cadastrado no Siclope precisa
ser configurado de tal forma que esteja habilitada a API de URL única e assim os
dados de key e token são gerados e apresentados no Siclope. Estas informações
são então compartilhadas com o usuário da API que estará autorizado a acessar
desta forma. Entretanto, é vedado o uso desta técnica para gravação de dados,
apenas leitura.

Exemplo de envio de uma consulta GET com uso de api e token:

View More
Plain Text


var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});
xhr.open("GET", "[URL da API fornecido pela ERPLAN]/Transfer/API/Planos?key=&token=&id=YYYY");
xhr.send();

--------------------------------------------------------------------------------


RETORNO DE ERROS

Todos os erros da API são retornadas com o mesmo formato, como por exemplo:

View More
Plain Text


Retorno JSON:
{
    "error": {
        "code": 401,
        "message": "Unauthorized"
    }
}
Outro exemplo de retorno de erro:
{
    "error": {
        "code": 400,
        "message": "Bad Request: API-TOKEN field missing"
    }
}

--------------------------------------------------------------------------------


MAPA DE RELACIONAMENTOS ENTRE TABELAS

Os dados desta API são fornecidos conforme especificação de forma bruta, sem
processamento, exceto os filtros que podem ser aplicados.

Desta forma, faz-se necessário entender como as tabelas se relacionam a fim de
que seja reconstituído o ambiente de ligações existentes no Siclope, a partir do
conhecimento das estruturas de chaves primárias e estrangeiras dos três módulos
cobertos pela API: Planos Ações, Ocorrências em SSMA e Comportamento Seguro.

Planos e Ações

Mapa de tabelas Planos e Ações

Ocorrências em SSMA

Mapa de tabelas Ocorrências SSMA

Comportamento Seguro

Mapa de tabelas Comportamento Seguro

Fale Fácil

Mapa de tabelas Fale Fácil

Inspeções e Auditorias

Mapa de tabelas Inspeções e Auditorias

Licenças e Condicionantes

Mapa de tabelas Licenças e Condicionantes


ENDPOINTS DE GRAVAÇÃO

Todos os itens desta API que permitem gravação na base de dados do Siclope
requerem método de envio POST ou DELETE e autenticação com Authorization Bearer,
cujo token é obtido após o login na API.

Só serão permitidos envios autorizados e com chave de sessão, além das regras de
cada endpoint serem seguidas.

AUTHORIZATIONBearer Token
Token

•••••••