Por onde devo começar? 👷

Primeiro passo é obter o token, pois para as demais requisições estaremos utilizando ele. A seguir serão detalhados os passos para realizar uma consulta.

Documentação da API no Swagger:

https://api-portal.deps.com.br/swagger/index.html

Obtendo o token de autenticação 🔒

Para que seja possível realizar uma consulta, primeiramente será necessário obter o token de autenticação.
O token poderá ser obtido através do método POST pelo seguinte endpoint:

https://api-portal.deps.com.br/api/v1/conta/entrar

Clique para exibir o header da requisição.

Content-Type: application/json

Clique para exibir o corpo da requisição.

{ 
    "email": "email", 
    "senha": "senha" 
}

Clique para exibir a resposta com sucesso (200 - Success) ✔️

{
  "access_token": "string",
  "expires_in": 0,
  "user": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "nome": "string",
    "email": "string",
    "telefone": "string",
    "ativo": 0,
    "clienteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "permissao": "string"
  }
}

Clique para exibir a resposta com erro (400 - Bad Request) ❌

{
  "codigo": "string",
  "mensagem": "string"
}

Dica! 💡

Usuário/ senha e produto de produção devem ser solicitados ao nosso setor comercial.

Configurações do header e parâmetros de entrada - Produção ⚙️

Após ter obtido o token de autenticação, é necessária a configuração do header e dos parâmetros de entrada.

Clique para exibir o header da requisição

Content-Type: application/json
Authorization: Bearer token

Importante!

Atente-se para não esquecer de colocar a palavra-chave "Bearer" antes do token de autenticação.

Parâmetros de entrada:

Parâmetro	Tipo de dado	Descrição	Obrigatório
documento	string	Refere-se ao CPF/CNPJ a ser consultado	Sim
identificadorProduto	string	Refere-se ao código identificador do produto cadastrado no Portal Deps	Sim
reutilizarDadosExistentes	boolean	Utilizado para consultas Smart. Valor padrão: false.	Não
autorizacaoScr	boolean	Utilizado para consultas SCR. Valor padrão: false. True = Indica que o cliente é responsável pela autorização e a autorização será cadastrada automaticamente no momento que a consulta foi realizada. False = O Portal faz a verificação se já existe a autorização. Ou seja, caso não exista autorização cadastrada, a consulta não é feita.	Não
version	integer	Refere-se à versão da API Mix. Informar o valor = 2.	Sim

Caso seja informado o parâmetro reutilizarDadosExistentes com o valor true, o Portal fará uma verificação na base de dados para saber se existe alguma consulta já realizada para o mesmo documento e produto. Caso possua, então os dados serão reutilizados e a consulta será finalizada normalmente. Caso contrário, a API retornará um erro (status code 400) com a seguinte resposta:

{
  "value": null,
  "messages": [
    "O documento consultado não possui informações na base de dados"
  ],
  "successMessage": null,
  "success": false
}

Fluxo de como utilizar

📌 Lembrando que o token deve ser enviado em todas as requisições que estão abaixo dele

Realizando consulta - Produção 🔎

A consulta DepsMix ou DepsSmart podem ser consumidas através de dois métodos: GET ou POST.

Endpoint da consulta:

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

Para ambos os métodos são utilizados o endpoint acima. Entretanto, o método POST pode ser utilizado nos casos em que é necessário enviar informações referentes aos dados complementares da análise, autorização de consulta SCR ou inscrição estadual. Vale ressaltar que o corpo da requisição POST não é obrigatório.

Clique para exibir o corpo da requisição POST da consulta Mix:

{
  "dadosComplementaresAnalise": {
    "dataPosicao": "2023-08-14T12:14:58.381Z",
    "contasReceberResumido": {
      "mediaDiasAtraso": 0,
      "mediaDiasVencido": 0,
      "mediaDiasVencer": 0,
      "totalPago": 0,
      "totalVencido": 0,
      "totalVencer": 0
    },
    "campoComplementar": 0,
    "maiorLimiteTomado": 0,
    "contasReceberDetalhado": {
      "tipoDetalhado": "string",
      "dataInicio": "2023-08-14T12:14:58.381Z",
      "dataFim": "2023-08-14T12:14:58.381Z",
      "titulos": [
        {
          "codigoTitulo": "string",
          "numeroTitulo": "string",
          "dataEmissao": "2023-08-14T12:14:58.381Z",
          "dataVencimento": "2023-08-14T12:14:58.381Z",
          "dataPagamento": "2023-08-14T12:14:58.381Z",
          "valor": 0,
          "saldo": 0
        }
      ]
    }
  },
  "autorizacaoConsulta": {
    "documento": "string",
    "nome": "string",
    "email": "string",
    "emailUsuario": "string"
  },
  "inscricaoEstadual": "string"
}

Clique para exibir a resposta com erro quando informado um documento inválido (400 - Bad Request) ❌

{
    "value": null,
    "messages": [
        "O documento 999 não pode ser consultado neste produto!"
    ],
    "successMessage": null,
    "success": false
}

Configuração do envio contas a receber para uso do bloco Smart ⚙️

Caso queira enviar contas receber interno para análise, deve ser enviado a opção de resumido ou detalhado, não será utilizado os dois na análise.
O Envio se faz necessário caso possua o bloco de análise e sua política análise essa informação.
A informação do contas a receber ajuda a conhecer o cliente que demanda crédito através do comportamento de pagamento do mesmo. Nos próximos tópicos descrevemos cada campo do contas a receber resumido e detalhado para fácil entendimento.

Contas a receber resumido

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

Tabela explicativa do contas a receber resumido:

Clique para exibir a tabela com o descritivo.

Campos do retorno	Descrição
{
"contasReceber": [	Estrutura contas à receber
{
"documento": "string",	Informar o documento que pertence o contas a receber
"dados": {
"dataPosicao": "2022-04-26",	Informar a data da posição da informação
"contasReceberResumido": {	Estrutura para envio do contas receber resumido
"mediaDiasAtraso": 0,	Enviar a média de dias atraso
"mediaDiasVencido": 0,	Enviar a média de dias vencido
"mediaDiasVencer": 0,	Enviar a média de dias a vencer
"totalPago": 0,	Enviar valor total pago do documento
"totalVencido": 0,	Enviar valor total de vencido do documento
"totalVencer": 0	Enviar valor total a vencer do documento
},
"campoComplementar": 0,	Campo genérico
"maiorLimiteTomado": 0,	Enviar o maior limite tomado, contas a receber em aberto + pedidos em aberto em situação que tomam crédito
}
}
],
"clienteId": "string"	Não é necessário enviar este campo se enviado com usuário cliente

Importante!

Não enviar médias negativas, pagamentos pontuais e antecipados as medias devem ser enviadas valor 0.

Contas a receber detalhado

Para o contas a receber detalhado você poderá utilizar a estrutura para integração vários documentos ou por apenas um documento.

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

Veja abaixo as tabelas explicativas do contas a receber detalhado:

Clique para exibir a tabela com o descritivo do contas a receber detalhado para vários documentos na mesma requisição.

Campos do retorno	Descrição
{
"inicio": "2023-08-14T13:50:52.002Z",	Informar a data de início
"fim": "2023-08-14T13:50:52.002Z",	Informar a data final
"clienteId": "string",	Não é necessário enviar este campo se enviado com usuário cliente
"tipoFiltro": "string",	Informar se é EMISSAO ou VENCIMENTO
"detalhado": [	Estrutura para envio do contas receber detalhado para vários documentos na mesma requisição
{
"documento": "string",	Informar o documento que pertence o contas a receber
"codigoTitulo": "string",	Informar a chave primária/código título na base do cliente, deverá ser um código único
"numeroTitulo": "string",	Número do título do contas a receber
"dataEmissao": "2023-08-14T13:50:52.002Z",	Informar a data de emissão do título
"dataVencimento": "2023-08-14T13:50:52.002Z",	Informar a data de vencimento do título
"dataPagamento": "2023-08-14T13:50:52.002Z",	Informar a data de pagamento do título (se houver)
"valor": 0,	Informar o valor do título
"saldo": 0	Informar o saldo caso o título não esteja pago por completo
}
]
}

Clique para exibir a tabela com o descritivo do contas a receber detalhado para apenas um documento na requisição.

Campos do retorno	Descrição
{
"inicio": "2023-08-14T13:50:52.002Z",	Informar a data de início
"fim": "2023-08-14T13:50:52.002Z",	Informar a data final
"clienteId": "string",	Não é necessário enviar este campo se enviado com usuário cliente
"tipoFiltro": "string",	Informar se é EMISSAO ou VENCIMENTO
"documento": "string",	Informar o documento que pertence o contas a receber
"detalhado": [	Estrutura para envio do contas receber detalhado para vários documentos na mesma requisição
{
"codigoTitulo": "string",	Informar a chave primária/código título na base do cliente, deverá ser um código único
"numeroTitulo": "string",	Número do título do contas a receber
"dataEmissao": "2023-08-14T13:50:52.002Z",	Informar a data de emissão do título
"dataVencimento": "2023-08-14T13:50:52.002Z",	Informar a data de vencimento do título
"dataPagamento": "2023-08-14T13:50:52.002Z",	Informar a data de pagamento do título (se houver)
"valor": 0,	Informar o valor do título
"saldo": 0	Informar o saldo caso o título não esteja pago por completo
}
]
}

Importante!

O contas a receber detalhado com valores negativos ou zerados não serão integrados.

Estrutura do arquivo JSON do contas a receber 📄

• Exemplo de arquivo JSON com informações do contas a receber resumido:

Clique aqui para exibir

{
	"contasReceber": [
		{
			"documento": "00360305000104",
			"dados": {
				"dataPosicao": "2022-11-09T13:22:00.894Z",
				"contasReceberResumido": {
					"mediaDiasAtraso": 2,
					"mediaDiasVencido": 0,
					"mediaDiasVencer": 10,
					"totalPago": 250000,
					"totalVencido": 300000,
					"totalVencer": 1000000
				},
				"campoComplementar": 0,
				"maiorLimiteTomado": 60000,
				"contasReceberDetalhado": null
			}
		}
	]
}

• Exemplo de arquivo JSON com informações do contas a receber detalhado por documento:

Clique aqui para exibir

{
  "inicio": "2023-01-01T14:25:23.243Z",
  "fim": "2023-08-01T14:25:23.243Z",
  "clienteId": "string",
  "tipoFiltro": "EMISSAO",
  "documento": "00360305000104",
  "detalhado": [
    {
      "codigoTitulo": "TT01",
      "numeroTitulo": "AGT09",
      "dataEmissao": "2023-01-01T14:25:23.243Z",
      "dataVencimento": "2023-01-05T14:25:23.243Z",
      "dataPagamento": "2023-01-05T14:25:23.243Z",
      "valor": 10000,
      "saldo": 0
    }
  ]
}

Como o contas a receber é exibido na Smart

Abaixo separamos 2 exemplos de como o contas a receber é exibido na Smart.

• Exemplo de como é exibido o contas a receber resumido na consulta Smart:

• Exemplo de como é exibido o contas a receber detalhado na consulta Smart:

Dica 💡

Tambem é possível enviar o contas a receber via arquivo CSV para mais detalhes clique aqui

Configuração autorização SCR ⚙️

Após ter obtido o token de autenticação, é necessário efetuar a configuração do header e dos parâmetros de entrada.
Enviar a e-mail para autorização SCR, quando o produto possuir este bloco.

Clique para exibir os detalhes a tabela com o descritivo.

Campos do retorno	Descrição
"autorizacaoConsulta": {
"documento": "string",	Documento que necessita de autorização
"nome": "string",	Nome ou razão social do documento
"email": "string"	Email que vai receber a solicitação de aprovação
},

Configuração do envio da consulta sintegra por inscrição ⚙️

Após ter obtido o token de autenticação, é necessário a configuração do header e dos parâmetros de entrada. Enviar no campo InscriçãoEstadual a inscricao a ser consultada, caso não seja enviada ele faz a consulta pelo CNPJ.

Clique para exibir os detalhes a tabela com o descritivo.

Campo	Descrição
"inscricaoEstadual": "string"	Enviar a inscrição estadual a ser consultada