API do 2tech

Esta documentação visa detalhar os métodos disponíveis na API da 2tech e os parâmetros necessários para integração.

Para que serve?

Este recurso permite que sistemas externos se integrem à API da 2tech, utilizando um token de autenticação para acessar dados de forma segura. Essa autenticação é essencial para garantir que apenas usuários autorizados consigam realizar consultas e operações via API.

O que é uma API?

API é a sigla para Interface de Programação de Aplicações. Trata-se de um conjunto de regras que permite que diferentes sistemas "conversem" entre si. Na prática, a API da 2tech permite que sistemas parceiros acessem informações e funcionalidades do sistema 2tech de forma automatizada, como se estivessem interagindo diretamente com o sistema — mas por meio de códigos e integrações.

Geração de token de acesso

Como usar na prática

Solicite suas credenciais de acesso ("username" e "password") abrindo um ticket com a equipe de Suporte da 2tech.
Com os dados em mãos, faça uma requisição POST para o endpoint:
```
https://app1.gerencialcredito.com.br/apiexterna/api/token
```
No corpo da requisição, envie os seguintes parâmetros:
- username: [seu nome de usuário, fornecido pelo suporte]
- password: [sua senha, fornecida pelo suporte]
- grant_type: "password"
Se os dados estiverem corretos, a resposta conterá o access_token, que deve ser utilizado nos headers das requisições seguintes para autenticação.

Você deve solicitar esses parâmetros através de ticket para a equipe de Suporte da 2tech.

Exemplo de consumo

var client = new RestClient("https://app1.gerencialcredito.com.br/apiexterna/api/token");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("application/x-www-form-urlencoded", "username=SEU_USERNAME&password=SUA_SENHA&grant_type=password", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

{
    "access_token": "oDg2iVNtls6NYXGq4ctvMBcDGq5nihUeT6g5yQiktWJI3oFaEtBTz1tKWAaYC43bJFLKX1usmP6Hnd4eQgQAYxJ30xTTROW65t2HRPK5EeLULTeRw2_n_6oQlKajysVYdTTPPYw2pHBgbCwLSaPOBrlzX60MEjdrSDXa6Lu3Ph0i5ZYw2pJsZC5SQKlbxs",
    "token_type": "bearer",
    "expires_in": 299
}

Consulta de contratos por período

Como usar na prática

Após gerar o token, é possível acessar o endpoint de Consulta de Contratos por Período, que retorna os contratos cadastrados dentro de um intervalo de datas.

Acesse o endpoint:

https://app1.gerencialcredito.com.br/apiexterna/api/contratos/periodo

Defina os seguintes cabeçalhos (headers) na requisição:
- Authorization: Bearer {access_token}
- apikey: {apiKey}
Informe os parâmetros exigidos pelo endpoint no corpo da requisição, conforme documentação técnica (consulte suporte se necessário).

Exemplos de consumo

contratos/periodo

var client = new RestClient("https://app1.gerencialcredito.com.br/apiexterna/api/contratos/periodo?dataInicio=2024-01-01&dataFim=2024-01-31&tipoData=1");
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer TOKEN");
request.AddHeader("apikey", "SUA_API_KEY");
IRestResponse response = client.Execute(request);

[
    {
        "contratoId": 1111111,
        "numeroProposta": "1111111111",
        "numeroContrato": "",
        "dataDigitacao": "2024-01-14T00:00:00",
        "valorBruto": 2857.14,
        "valorLiquido": 2857.14,
        "prazo": "84",
        "valorParcela": 100.00,
        "statusProposta": "PAGO",
        "dataStatusProposta": "2024-01-22T00:00:00",
        "banco": "ITAÚ",
        "convenio": "INSS",
        "tabela": "Tabela Normal",
        "codigoVendedor": "1111",
        "vendedor": "AAA21",
        "cpfCnpjVendedor": "11111111111",
        "cpfCliente": "11111111111",
        "nomeCliente": "NOME DO CLIENTE",
        "matriculaCliente": "111111111"
        "tipoContrato": "Contrato Novo"
    }
]

No parâmetro tipoData da requisição utilize uma das opções:

Usar 1 para "Data de Digitação no banco"

Usar 2 para "Data de Pagamento ao cliente (data de liberação do crédito)"

Usar 3 para "Data de Pagamento da Comissão do Vendedor"

Usar 4 para "Data de Última Alteração de Status"

contratos/periodo/mes-atual

var client = new RestClient("https://app1.gerencialcredito.com.br/apiexterna/api/contratos/periodo/mes-atual?tipoData=1");
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer TOKEN");
request.AddHeader("apikey", "SUA_API_KEY");
IRestResponse response = client.Execute(request);

[
    {
        "contratoId": 1111111,
        "numeroProposta": "1111111111",
        "numeroContrato": "",
        "dataDigitacao": "2024-01-14T00:00:00",
        "valorBruto": 2857.14,
        "valorLiquido": 2857.14,
        "prazo": "84",
        "valorParcela": 100.00,
        "statusProposta": "PAGO",
        "dataStatusProposta": "2024-01-22T00:00:00",
        "banco": "ITAÚ",
        "convenio": "INSS",
        "tabela": "Tabela Normal",
        "codigoVendedor": "1111",
        "vendedor": "AAA21",
        "cpfCnpjVendedor": "11111111111",
        "cpfCliente": "11111111111",
        "nomeCliente": "NOME DO CLIENTE",
        "matriculaCliente": "111111111"
    }
]

contratos/periodo/quinzenal

var client = new RestClient("https://app1.gerencialcredito.com.br/apiexterna/api/contratos/periodo/quinzenal?tipoData=1");
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer TOKEN");
request.AddHeader("apikey", "SUA_API_KEY");
IRestResponse response = client.Execute(request);

[
    {
        "contratoId": 1111111,
        "numeroProposta": "1111111111",
        "numeroContrato": "",
        "dataDigitacao": "2024-01-14T00:00:00",
        "valorBruto": 2857.14,
        "valorLiquido": 2857.14,
        "prazo": "84",
        "valorParcela": 100.00,
        "statusProposta": "PAGO",
        "dataStatusProposta": "2024-01-22T00:00:00",
        "banco": "ITAÚ",
        "convenio": "INSS",
        "tabela": "Tabela Normal",
        "codigoVendedor": "1111",
        "vendedor": "AAA21",
        "cpfCnpjVendedor": "11111111111",
        "cpfCliente": "11111111111",
        "nomeCliente": "NOME DO CLIENTE",
        "matriculaCliente": "111111111"
        "tipoContrato": "Contrato Novo"
    }
]

contratos/periodo/semanal

var client = new RestClient("https://app1.gerencialcredito.com.br/apiexterna/api/contratos/periodo/semanal?tipoData=1");
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer TOKEN");
request.AddHeader("apikey", "SUA_API_KEY");
IRestResponse response = client.Execute(request);

[
    {
        "contratoId": 1111111,
        "numeroProposta": "1111111111",
        "numeroContrato": "",
        "dataDigitacao": "2024-01-14T00:00:00",
        "valorBruto": 2857.14,
        "valorLiquido": 2857.14,
        "prazo": "84",
        "valorParcela": 100.00,
        "statusProposta": "PAGO",
        "dataStatusProposta": "2024-01-22T00:00:00",
        "banco": "ITAÚ",
        "convenio": "INSS",
        "tabela": "Tabela Normal",
        "codigoVendedor": "1111",
        "vendedor": "AAA21",
        "cpfCnpjVendedor": "11111111111",
        "cpfCliente": "11111111111",
        "nomeCliente": "NOME DO CLIENTE",
        "matriculaCliente": "111111111"
        "tipoContrato": "Contrato Novo"
    }
]

Criação de propostas em lote

Como usar na prática

Esse método viabiliza a criação e processamento de uma nova importação de propostas.

1. Criar Importação

Faça uma requisição POST para o endpoint:

https://app1.gerencialcredito.com.br/apiexterna/api/importacao

Exemplos de consumo

Faça o download do json completo para visualizar todo os dados:

2KB

json-completo.txt

REQUEST C#

RESPONSE

{

"layoutId": 3,

"titulo": "Importação Teste Automação",

"correspondenteId": 1

}

{

"sucesso": true,

"mensagem": "Importação criada com sucesso",

"data": {

"importacaoId": 23565,

"titulo": "Importação Teste Automação"

}

2. Inserir Registros de Contratos

Faça uma requisição do tipo POST para o endpoint:

https://app1.gerencialcredito.com.br/apiexterna/api/importacao/registros

Exemplos de consumo

REQUEST C#

RESPONSE

{

"ImportacaoDigitacaoPropostaId": 1111,

"CodigoInstituicaoFinanceira": 0,

"UsuarioDigitacao": "111111_11111",

"NomeCliente": "NOME DO CLIENTE",

"CpfCliente": "1111111111",

"DataNascimento": "1985-05-03T00:00:00",

"Matricula": "1111111111",

"Orgao": "1111111111",

"Endereco": "ENDEREÇO DO CLIENTE",

"Bairro": "BAIRRO DO CLIENTE",

"Cidade": "CIDADE DO CLIENTE",

"Estado": "ESTADO DO CLIENTE",

"Cep": "1111111111",

"NumeroProposta": "1111111111",

"DataInclusaoProposta": "2024-11-01T00:00:00",

"CodigoConvenio": "INSS BENEFICIO",

"CodigoProduto": "1111111111",

"DescricaoProduto": "INSS CB_REP LEGAL LOAS",

"ValorBruto": 1637.84,

"ValorLiquido": 1637.84,

"Prazo": 84,

"ValorParcela": 49.42,

"CodigoPromotora": "1111111111",

"NumeroContrato": "1111111111",

"SituacaoBancoEmpresa": "INT",

"SituacaoPagamentoCliente": "INT",

"TipoProposta": "INSS CB_REP LEGAL LOAS",

"RgCliente": "1111111111-1"

// ... outros campos opcionais omitidos por simplicidade

}

{

"sucesso": true,

"mensagem": "Registros inseridos com sucesso",

"data": {}

}

3. Processar a Importação

Faça uma requisição POST para o endpoint:

https://app1.gerencialcredito.com.br/apiexterna/api/importacao/{importacaoId}/processar

Exemplos de consumo

REQUEST C#

RESPONSE

Body: vazio

{

"sucesso": true,

"mensagem": "Importação adicionada à fila de processamento",

"data": {}

}

4. Campos obrigatórios no registro de contrato

Nem todos os campos da estrutura apresentada são obrigatórios, mas os mais comuns e necessários são:

Campo

Descrição

ImportacaoDigitacaoPropostaId

ID da importação criada

NomeCliente

Nome completo do cliente

CpfCliente

CPF do cliente (apenas números)

DataNascimento

Formato: yyyy-MM-ddTHH:mm:ss

Matricula

Identificação funcional

CodigoProduto

Código do produto contratado

ValorBruto

Valor bruto do empréstimo

Prazo

Número de parcelas

ValorParcela

Valor de cada parcela

NumeroContrato

Número de identificação do contrato

Requisitos de uso:

O layoutId, correspondenteId, e CodigoPromotora devem ser previamente informados/configurados no 2tech.
Os contratos devem seguir o padrão esperado para o layout utilizado.

Dicas importantes

O token gerado possui tempo de validade. Revalide ou gere um novo token conforme a necessidade da sua integração.
Toda requisição à API da 2tech deve incluir o token no cabeçalho Authorization:
```
Authorization: Bearer [seu access_token]
```
A API é destinada a parceiros que desejam consultar ou enviar dados relacionados à operação de crédito com mais agilidade.

NextAcesso a Dados para BI

Last updated 1 month ago

Was this helpful?