ICG: API Functions

You will be able to create integrations with your system, or your company’s systems, using the resources  of API’s available for the ICG.

 

In this article we will see:

 

• What are APIs for?
• Autentication
• API for KPIs
• API for Measurements
• API for Plans
• API for Users
• API for Linking
• API for Totalization

 

What are APIs for?

 API is a set of routines and programming patterns for accessing a software application or a web-based platform. The acronym API refers to the English term Application Programming Interface which means Application Programming Interface.

An API serves to create an integration of data from one software to another.

The end-point is the domain plus the GET, PUT, POST or DELETE function as in the example below:

 

IMPORTANT:

Before starting, you need to request the permission and token release for authentication on the ICG server. For this, just send an email to suporte@qualitin.com informing and the Company and User used in the login of the ICG.

 

Autentication

To authenticate server access through the API, select the Authorization tab, select the Base Auth type.

The token must be entered in the username field.

 

API for KPI

To view the content, click on the image or go to: api.qualitin.com, you will be redirected to Qualitin’s APIs page.

• PUT – Edits KPI.
• POST – Includes KPI.
• Delete – Deletes KPI.

 

API for Measurements

To view the content, click on the image or go to: api.qualitin.com, you will be redirected to Qualitin’s APIs page.

• PUT – Edits the KPI measurements

Note: At the end of each name, there is which type of KPI the code was defined.

 

API for Plans

To view the content, click on the image or go to: api.qualitin.com, you will be redirected to Qualitin’s APIs page.

• PUT – Edits an Action Plan and/or an Action.
• GET – Search for a Plan.
• POST – Includes an Action Plan and/or an Action.
• Delete – Deletes an Action Plan and/or an Action.

 

API for Users

To view the content, click on the image or go to: api.qualitin.com, you will be redirected to Qualitin’s APIs page.

• PUT – Edits a User.
• POST – Adds a User.
• Delete – Deletes a User.

 

API for Linking

To view the content, click on the image or go to: api.qualitin.com, you will be redirected to Qualitin’s APIs page.

• GET – Search for a Link.
• POST – Includes a Link.
• Delete – Deletes a Link.

 

API for Totalization

To view the content, click on the image or go to: api.qualitin.com, you will be redirected to Qualitin’s APIs page.

• GET – Search for a Totalization.
• PUT – Edit a Totalization.
• POST – Includes a Totalization.
• Delete – Deletes a Totalization.

 

REMINDER:
Qualitin makes the APIs available for the integration to be performed by the interested party.