Usando a API para consultar qualificações

Para consultar qualificações usando a API é preciso utilizar a interface do sistema para gerar um
token de acesso da API.

Cumprindo esse requisito, siga os passos descritos abaixo:

1. Listar todas as qualificações

Este endpoint retorna todas as qualificações cadastradas no sistema.

Exemplo de chamada:

GET

/api/v1/qualifications

Params

Authorization

	Key	Value

var axios = require("axios").default;

var options = {
  method: 'GET',
  url: 'https://exemplo.callix.com.br/api/v1/qualifications',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer {seu_token
  }'}
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

Para testar, configure na página de Autenticação.

Exemplo de resposta:


{
  "data": [
    {
      "id": 1,
      "type": "qualifications",
      "attributes": {
        "name": "Qualificação 1",
        "cpc": true,
        "success": true,
        "is_system_qualification": false
      }
    },
    {
      "id": 2,
      "type": "qualifications",
      "attributes": {
        "name": "Qualificação 2",
        "cpc": true,
        "success": false,
        "is_system_qualification": false
      }
    }
  ]
}

Filtros disponíveis:

Esta rota permite filtrar qualificações usando os seguintes parâmetros:

Filtro	Tipo	Descrição	Exemplo
`filter[cpc]`	boolean	Retorna apenas qualificações cujo atributo `cpc` seja igual ao valor definido	`filter[cpc]=true`
`filter[success]`	boolean	Retorna apenas qualificações cujo atributo `success` seja igual ao valor definido	`filter[success]=true`
`filter[is_system_qualification]`	boolean	Retorna apenas qualificações cujo atributo `is_system_qualification` seja igual ao valor definido	`filter[is_system_qualification]=false`

Exemplo de chamada com filtros:

GET

/api/v1/qualifications

Params

Authorization

	Key	Value

var axios = require("axios").default;

var options = {
  method: 'GET',
  url: 'https://exemplo.callix.com.br/api/v1/qualifications',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer {seu_token
  }'}
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

Para testar, configure na página de Autenticação.

2. Consultar uma qualificação específica

Este endpoint retorna informações detalhadas de uma qualificação específica usando seu ID.

Exemplo de chamada:

GET

/api/v1/qualifications/1

Params

Authorization

	Key	Value

var axios = require("axios").default;

var options = {
  method: 'GET',
  url: 'https://exemplo.callix.com.br/api/v1/qualifications/1',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer {seu_token
  }'}
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

Para testar, configure na página de Autenticação.

Exemplo de resposta:


{
  "data": {
    "id": 1,
    "type": "qualifications",
    "attributes": {
      "name": "Qualificação 1",
      "cpc": true,
      "success": true,
      "is_system_qualification": false
    }
  }
}

Atributos

Atributo	Tipo	Descrição
`name`	string	Nome da qualificação
`cpc`	boolean	Indica se é uma qualificação de contato com a pessoa certa
`success`	boolean	Indica se é uma qualificação de sucesso
`is_system_qualification`	boolean	Indica se é uma qualificação do sistema