ICG: Funções de API’s

Você poderá criar integrações com seu sistema, ou sistemas de sua empresa, utilizando os recursos  de API’s disponíveis para o ICG.

 

Neste artigo veremos:

 

• Para que servem as APIs?
• Autenticação
• API para Itens de Controle
• API para Medições
• API para Planos
• API para Usuários
• API para Vinculação
• API para Totalização

 

Para que servem as APIs?

API é um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software ou plataforma baseado na Web. A sigla API refere-se ao termo em inglês Application Programming Interface que significa Interface de Programação de Aplicativos.

Uma API serve para criar uma integração de dados de um software a outro.

O end-point é o domínio mais a função GET, PUT, POST ou DELETE como no exemplo abaixo:

 

IMPORTANTE:

Antes de começar, é preciso solicitar a liberação da permissão e do token para autenticação no servidor do ICG. Para isto, basta enviar um e-mail para  suporte@qualitin.com informando e a Empresa e o Usuário utilizados no login do ICG.

 

 

Autenticação

Para autenticar o acesso ao servidor através da API, selecione a guia Autorização, selecione o tipo Base Auth.

O token deve ser inserido no campo de nome de usuário.

 

API para Item de Controle

Para visualizar o conteúdo clique na imagem ou acesse: api.qualitin.com, você será redirecionado a página de APIs da Qualitin.

• PUT – Edita um Item de Controle.
• POST – Inclui um Item de Controle.
• Delete – Deleta um Item de Controle.

 

API para Medições

Para visualizar o conteúdo clique na imagem ou acesse: api.qualitin.com, você será redirecionado a página de APIs da Qualitin.

• PUT –  Edita as medições do item de controle.

Obs.: Ao final de cada nome, possui qual tipo de Item de Controle o código foi definido.

 

API para Planos

Para visualizar o conteúdo clique na imagem ou acesse: api.qualitin.com, você será redirecionado a página de APIs da Qualitin.

• PUT – Edita um Plano de Ação e/ou uma Ação.
• GET – Busca um Plano.
• POST – Inclui um Plano de Ação e/ou uma Ação.
• Delete – Deleta um Plano de Ação e/ou uma Ação.

 

API para Usuários

Para visualizar o conteúdo clique na imagem ou acesse: api.qualitin.com, você será redirecionado a página de APIs da Qualitin.

• PUT – Edita um Usuário.
• POST – Inclui um Usuário.
• Delete – Deleta um Usuário.

 

API para Vinculação

Para visualizar o conteúdo clique na imagem ou acesse: api.qualitin.com, você será redirecionado a página de APIs da Qualitin.

• GET – Busca uma Vinculação.
• POST – Inclui uma Vinculação.
• Delete – Deleta uma Vinculação.

 

API para Totalização 

Para visualizar o conteúdo clique na imagem ou acesse: api.qualitin.com, você será redirecionado a página de APIs da Qualitin.

• GET – Busca uma Totalização.
• PUT – Edita uma Totalização.
• POST – Inclui uma Totalização.
• Delete – Deleta uma Totalização.

 

LEMBRETE:
A Qualitin disponibiliza as APIs para que a integração seja executada por parte do interessado.