Deps Documentação

# Exemplo consumo da API 👩‍💻

Segue exemplo em C# para consumo da api.

Clique para exibir exemplo de consumo. 

// See https://aka.ms/new-console-template for more information

using Newtonsoft.Json.Linq;
using System.Net.Http.Headers;
using System.Net.Http.Json;

var endpointApi = "https://homologacao-portal.deps.com.br/";

//Para consumir a API de produção basta utilizar a variável abaixo no lugar do "endpointApi"
var endpointApiProducaoV2 = "https://api-portal.deps.com.br/api/v2/";

var httpClient = new HttpClient();
httpClient.BaseAddress = new Uri(endpointApi);

//Realizar login e buscar o token
var data = JsonContent.Create(new
{
    email = "[email protected]",
    senha = "deps"
});

var response = await httpClient.PostAsync("conta/entrar", data);
if (!response.IsSuccessStatusCode)
    throw new Exception("Erro ao obter token");

var json = JObject.Parse(await response.Content.ReadAsStringAsync());
var token = json.GetValue("access_token").Value<string>();

//Realizar consulta passando o token

httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);

var dataConsulta = JsonContent.Create(new
{
    dadosComplementaresAnalise = new
    {
        dataPosicao = DateTime.Now,
        contasReceberResumido = new
        {
            mediaDiasAtraso = 0,
            mediaDiasVencido = 0,
            mediaDiasVencer = 0,
            totalPago = 0,
            totalVencido = 0,
            totalVencer = 0
        }
    }
});

var documento = "05284733000119";
var identificadorProduto = "AAAAAA";
var query = $"?documento={documento}&identificadorProduto={identificadorProdutor&reutilizarDadosExistentes=false";

var responseConsulta = await httpClient.PostAsync($"consultas/depsmix{query}", dataConsulta);
if (!responseConsulta.IsSuccessStatusCode)
    throw new Exception("Erro ao consultar");


Console.WriteLine(await responseConsulta.Content.ReadAsStringAsync());

# Dúvidas frequentes

# Como devo enviar o Contas a Receber?

O envio do contas a receber pode ser em um momento anterior a consulta ou no momento em que realizar a consulta:

Antes de realizar a consulta:

  • Contas a receber resumido:

Endpoint POST: https://analise.deps.com.br/api/v1/contas-receber (opens new window)

  • Contas a receber detalhado:

Endpoint POST: https://contas-receber.deps.com.br/api/v1/contas-receber/detalhado (opens new window)

Quando é realizada a chamada da consulta:

Endpoint POST: https://api-portal.deps.com.br/api/v2/consultas/depsmix (opens new window)

Dica!

Você pode enviar as informações do contas a receber no campo de dados complementares, no link desta documentação você pode ver todos os parâmetros que podem ser enviados ao fazer a consulta, ou se preferir pode verificar diretamente o Swagger (opens new window).

Caso você não tenha verificado a documentação da API do contas a receber você pode acessar pelo Swagger ou clicando aqui

Dica!

Caso você deseje verificar o manual do contas a receber basta clicar aqui.

# Como solicitar uma nova consulta a partir dos dados atualizados?

Caso tenha optado por enviar o contas a receber no momento anterior a consulta, basta realizar a consulta no endpoint:

 https://api-portal.deps.com.br/api/v2/consultas/depsmix

Que ele já irá buscar as informações que foram enviadas no contas a receber e retornará as informações da consulta, como limite sugerido, classificação, e outras informações.

O objeto que é retornado aqui é similar ao objeto que temos no ambiente de homologação.

# Como consultar os dados da última consulta?

A consulta já é retornada no momento em que ela é realizada, ou seja, a requisição é de forma síncrona

# O envio do contas a receber para validação, onde verifico?

Sugerimos que o envio do contas a receber seja já em produção onde pode ser conferido pelos usuarios. Depois de homologado o contas a receber, basta nos solicitar a limpeza das informações.

← Dados da consulta →