NAV -image
bash php javascript

Introduction

Documentação de API

Esta documentação tem como objetivo fornecer todas as informações que você precisa para trabalhar com nossa API.

Base URL

https://sandbox.toolconsig.com.br

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Autenticação

Login

Realiza login e retorna o token de autenticação JWT.

Example request:

curl -X POST \
    "https://sandbox.toolconsig.com.br/api/auth/login" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "X-Tenant: dvalor" \
    -d '{"email":"natus","password":"temporibus"}'


$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://sandbox.toolconsig.com.br/api/auth/login',
    [
        'headers' => [
            'Accept' => 'application/json',
            'X-Tenant' => 'dvalor',
        ],
        'json' => [
            'email' => 'natus',
            'password' => 'temporibus',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://sandbox.toolconsig.com.br/api/auth/login"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-Tenant": "dvalor",
};

let body = {
    "email": "natus",
    "password": "temporibus"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

{
    "status": "success",
    "token": "eyJ0eXAiOiJKV1QiLCJh..."
}

Example response (401):

{
    "status": "error",
    "message": "Credenciais inválidas"
}

Request   

POST api/auth/login

Body Parameters

email  string  
Email do usuário. Exemplo: usuario@teste.com

password  string  
Senha do usuário. Exemplo: secret

Endpoints

Listar Tabelas de comissão

requires authentication

Retorna todas as tabelas disponíveis para uso.

Example request:

curl -X GET \
    -G "https://sandbox.toolconsig.com.br/api/external/servicos/tabelas?banco=9&convenio=53&tipo=1&tabela=CARTAO+BENEFICIO&prazo=96" \
    -H "Authorization: Bearer {YOUR_AUTH_KEY}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "X-Tenant: dvalor"

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://sandbox.toolconsig.com.br/api/external/servicos/tabelas',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
            'X-Tenant' => 'dvalor',
        ],
        'query' => [
            'banco'=> '9',
            'convenio'=> '53',
            'tipo'=> '1',
            'tabela'=> 'CARTAO BENEFICIO',
            'prazo'=> '96',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://sandbox.toolconsig.com.br/api/external/servicos/tabelas"
);

let params = {
    "banco": "9",
    "convenio": "53",
    "tipo": "1",
    "tabela": "CARTAO BENEFICIO",
    "prazo": "96",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-Tenant": "dvalor",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
  {
   "id": 447236,
   "banco": "AMIGOZ",
   "convenio": "INSS - INSTITUTO NACIONAL DE SEGURO SOCIAL - BR",
   "tipo": "CARTÃO C/ SAQUE AUTORIZADO",
   "tabela": "CARTAO BENEFICIO INSS - C/ SEG. DIAMANTE",
   "digital": "SIM",
   "taxa": "",
   "vigencia": "2025-05-30",
   "prazo": "96",
   "idade": "",
   "vr_ctr_atual": "",
   "comissao_agente_moeda": 0,
   "comissao_liquido_agente_percentual": 15.5,
   "comissao_bruto_agente_percentual": 0,
   "codigo_mg": "144379"
  },
  {
   "id": 447237,
   "banco": "AMIGOZ",
   "convenio": "INSS - INSTITUTO NACIONAL DE SEGURO SOCIAL - BR",
   "tipo": "CARTÃO C/ SAQUE AUTORIZADO",
   "tabela": "CARTAO BENEFICIO INSS - C/ SEG. DIAMANTE",
   "digital": "SIM",
   "taxa": "",
   "vigencia": "2025-05-30",
   "prazo": "84",
   "idade": "",
   "vr_ctr_atual": "",
   "comissao_agente_moeda": 0,
   "comissao_liquido_agente_percentual": 15.5,
   "comissao_bruto_agente_percentual": 0,
   "codigo_mg": "144380"
  },
]

Request   

GET api/external/servicos/tabelas

Query Parameters

banco  string  
Banco

convenio  string  
Convênio

tipo  string  
Produto

tabela  string optional  
Nome da tabela

prazo  string optional  
Prazo

Listar Produção

requires authentication

Retorna todos os contratos pagos.

Example request:

curl -X GET \
    -G "https://sandbox.toolconsig.com.br/api/external/servicos/producoes?cpf=422.581.366-52&proposta=53&tipo=1+-+Data+Importa%C3%A7%C3%A3o+%7C+2+-+Data+Cr%C3%A9dito+Cliente+%7C+3+-+Data+Opera%C3%A7%C3%A3o+%7C+4+-+Data+Pagamento&fisico_pendente=S+%7C+N&inicio=2024-08-02&fim=2024-08-02&page=1" \
    -H "Authorization: Bearer {YOUR_AUTH_KEY}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "X-Tenant: dvalor"

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://sandbox.toolconsig.com.br/api/external/servicos/producoes',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
            'X-Tenant' => 'dvalor',
        ],
        'query' => [
            'cpf'=> '422.581.366-52',
            'proposta'=> '53',
            'tipo'=> '1 - Data Importação | 2 - Data Crédito Cliente | 3 - Data Operação | 4 - Data Pagamento',
            'fisico_pendente'=> 'S | N',
            'inicio'=> '2024-08-02',
            'fim'=> '2024-08-02',
            'page'=> '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://sandbox.toolconsig.com.br/api/external/servicos/producoes"
);

let params = {
    "cpf": "422.581.366-52",
    "proposta": "53",
    "tipo": "1 - Data Importação | 2 - Data Crédito Cliente | 3 - Data Operação | 4 - Data Pagamento",
    "fisico_pendente": "S | N",
    "inicio": "2024-08-02",
    "fim": "2024-08-02",
    "page": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-Tenant": "dvalor",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "current_page": 1,
    "data": [
        {
            "id": 21185,
            "cpf": "18181252420",
            "cliente": "LUCIA MARIA DE MEDEIROS SANTOS",
            "banco": "C6 BANK S.A",
            "proposta": "970717784",
            "contrato": "970717784",
            "prazo": "96",
            "produto": "Refin \/ Portabilidade",
            "tabela": "C6 BANK - INSS - DIGITAL WEB PLUS REFIN PORT FLEX 4 - TX 1,649 A 1,600 (240142)",
            "valor_contrato": 5082.06,
            "data_operacao": "2025-08-13",
            "data_credito_cliente": "2025-08-26",
            "data_ncr": "2025-08-27",
            "corretor_perc_comissao": 1.14,
            "corretor_valor_comissao": 57.94,
            "pago": "S",
            "data_recebimento": null,
            "valor_base": 5082.06,
            "corretor": "ADELMO DA SILVA GOMES"
        }
    ],
    "first_page_url": "http:\/\/localhost:8000\/api\/external\/servicos\/producoes?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http:\/\/localhost:8000\/api\/external\/servicos\/producoes?page=1",
    "next_page_url": null,
    "path": "http:\/\/localhost:8000\/api\/external\/servicos\/producoes",
    "per_page": 10,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}

Request   

GET api/external/servicos/producoes

Query Parameters

cpf  string optional  
CPF

proposta  string optional  
Proposta

tipo  string optional  
Data a ser consultada

fisico_pendente  string optional  
Físico Pendente

inicio  string optional  
Data Início

fim  string optional  
Data Final

page  string optional  
Página

Relatório de comissão

requires authentication

Retorna o relatório de comissão dos contratos pagos.

Example request:

curl -X GET \
    -G "https://sandbox.toolconsig.com.br/api/external/servicos/relatorios/comissao?inicio=2024-08-02&fim=2024-08-02" \
    -H "Authorization: Bearer {YOUR_AUTH_KEY}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "X-Tenant: dvalor"

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://sandbox.toolconsig.com.br/api/external/servicos/relatorios/comissao',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
            'X-Tenant' => 'dvalor',
        ],
        'query' => [
            'inicio'=> '2024-08-02',
            'fim'=> '2024-08-02',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://sandbox.toolconsig.com.br/api/external/servicos/relatorios/comissao"
);

let params = {
    "inicio": "2024-08-02",
    "fim": "2024-08-02",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-Tenant": "dvalor",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "content-type": "application\/pdf",
    "description": "Retorna um arquivo PDF contendo os dados do relatório."
}

Request   

GET api/external/servicos/relatorios/comissao

Query Parameters

inicio  string  
Data Início

fim  string  
Data Final

Listar Bancos

requires authentication

Retorna todos os bancos cadastrados.

Example request:

curl -X GET \
    -G "https://sandbox.toolconsig.com.br/api/external/bancos/listarAll" \
    -H "Authorization: Bearer {YOUR_AUTH_KEY}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "X-Tenant: dvalor"

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://sandbox.toolconsig.com.br/api/external/bancos/listarAll',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
            'X-Tenant' => 'dvalor',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://sandbox.toolconsig.com.br/api/external/bancos/listarAll"
);

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-Tenant": "dvalor",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
 {
   "id": 53,
   "nome": "AMIGOZ",
   "ativo": "S"
 },
 {
   "id": 6,
   "nome": "BANRISUL S.A",
   "ativo": "S"
  },
]

Example response (401):

{
    "status": "error",
    "message": "Credenciais inválidas"
}

Request   

GET api/external/bancos/listarAll

Listar Produtos

requires authentication

Retorna todos os convênios cadastrados para o banco selecionado.

Example request:

curl -X GET \
    -G "https://sandbox.toolconsig.com.br/api/external/convenios/tipos?banco=9&convenio=53" \
    -H "Authorization: Bearer {YOUR_AUTH_KEY}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "X-Tenant: dvalor"

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://sandbox.toolconsig.com.br/api/external/convenios/tipos',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
            'X-Tenant' => 'dvalor',
        ],
        'query' => [
            'banco'=> '9',
            'convenio'=> '53',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://sandbox.toolconsig.com.br/api/external/convenios/tipos"
);

let params = {
    "banco": "9",
    "convenio": "53",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-Tenant": "dvalor",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
 {
   "id": 1,
   "nome": "CARTÃO C/ SAQUE AUTORIZADO",
   "ativo": "S"
 },
]

Example response (401):

{
    "status": "error",
    "message": "Credenciais inválidas"
}

Request   

GET api/external/convenios/tipos

Query Parameters

banco  string  
Banco

convenio  string  
Convênio

Listar Convênios do Banco

requires authentication

Retorna todos os convênios cadastrados para o banco selecionado.

Example request:

curl -X GET \
    -G "https://sandbox.toolconsig.com.br/api/external/bancos/convenios?banco=9" \
    -H "Authorization: Bearer {YOUR_AUTH_KEY}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "X-Tenant: dvalor"

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://sandbox.toolconsig.com.br/api/external/bancos/convenios',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
            'X-Tenant' => 'dvalor',
        ],
        'query' => [
            'banco'=> '9',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://sandbox.toolconsig.com.br/api/external/bancos/convenios"
);

let params = {
    "banco": "9",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-Tenant": "dvalor",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
 {
   "id": 1,
   "nome": "INSS - INSTITUTO NACIONAL DE SEGURO SOCIAL - BR",
   "ativo": "S"
 },
 {
   "id": 4,
   "nome": "GOVERNO DO ESTADO DA PARAIBA - PB",
   "ativo": "S"
  },
]

Example response (401):

{
    "status": "error",
    "message": "Credenciais inválidas"
}

Request   

GET api/external/bancos/convenios

Query Parameters

banco  string  
Banco

bash php javascript