Por onde devo começar? 👷 | Deps Documentação

# 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 ⚙️

Atenção!

Certifique-se de que vocẽ esteja no ambiente Deps Share para realizar os próximos passos.

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.

# Endpoints

Essa API possui alguns agrupamentos de endpoints para que as requisições sejam feitas, são eles:

Grupo
Compras
Alerta
Consulta

# Grupo

Nesse agrupamento você poderá ter acesso aos endpoints relacionados aos Grupos Share. Abaixo segue a descrição de cada um e como utilizá-los:

# Associar cliente

Para associar um cliente a um grupo Share, é necessário enviar uma requisição contendo no corpo da solicitação o identificador do Grupo Share e o identificador do cliente.

Método: POST
Endpoint da consulta: /api/v1/grupo/associar-cliente

Clique para exibir o corpo da requisição

{
  "grupoId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clienteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Campos do JSON:

Campo	Descrição
grupoId	Informar o identificador do grupo que se deseja consultar.
clienteId	Informar o identificador do cliente que se deseja consultar.

# Criar grupo

Para cadastrar um grupo Share, é necessário enviar à API uma requisição contendo apenas o nome do grupo desejado no corpo da solicitação (Request body).

Método: POST
Endpoint da consulta: api/v1/grupo

Clique para exibir o corpo da requisição

{
  "nome": "string"
}

Campos do JSON:

Campo	Descrição
nome	Informar o nome do grupo que se deseja cadastrar.

# Buscar grupo

Para buscar grupos, é necessário enviar à API uma requisição incluindo um filtro, página e tamanho desejados pelo usuário nos parâmetros da consulta.

Atenção!

A resposta da API será uma lista de grupos Share cadastrados.

Método: GET
Endpoint da consulta: /api/v1/grupo

Parâmetros da Consulta:

Campo	Descrição	Tipo do Campo
Filter	Informar o filtro desejado para consultar o grupo.	Caracter (String)
Page	Informar a página em que se encontra o grupo que se deseja consultar.	Inteiro (Integer)
Size	Informar o tamanho de itens que se deseja possuir na consulta.	Inteiro (Integer)

# Desassociar um cliente ao grupo

Para desassociar um cliente do grupo ao qual está vinculado, é necessário incluir na requisição um parâmetro contendo o identificador do cliente que se deseja desassociar.

Método: DELETE
Endpoint da consulta: /api/v1/grupo/desassociar-cliente/{clienteId}

Parâmetros da Consulta:

Campo	Descrição	Tipo do Campo
clienteId	Informar o identificador do cliente que se deseja desassociar do grupo.	Caracter (String)

# Buscar grupo que o cliente é associado

Para buscar um grupo específico ao qual um cliente esteja associado, é necessário enviar à API uma requisição contendo o identificador do cliente como parâmetro.

Método: GET
Endpoint da consulta: /ap/v1/grupo/cliente/{clienteId}

Parâmetros da Consulta:

Campo	Descrição	Tipo do Campo
clienteId	Informar o identificador do cliente que se deseja buscar o grupo.	Caracter (String)

# Buscar parametrizações de um grupo

Para buscar os parâmetros de um grupo específico, é necessário enviar à API uma requisição com o identificador do grupo desejado como parâmetro.

Método: GET
Endpoint da consulta: /api/v1/grupo/{id}/parametrizacao

Parâmetros da Consulta:

Campo	Descrição	Tipo do Campo
id	Informar o identificador do grupo que se deseja buscar as parametrizações.	Caracter (String)

# Editar parametrização de um grupo

Para editar a parametrização de um grupo específico, é necessário enviar à API uma requisição com um corpo de solicitação (Request body) contendo o parâmetro, identificador do grupo e valor.

Método: PATCH
Endpoint da consulta: /api/v1/grupo/parametrizacao

Clique para exibir o corpo da requisição

{
  "parametro": 0,
  "grupoId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "valor": "string"
}

Campos do JSON:

Campo	Descrição	Tipo do Campo
parametro	Informar o parâmetro do grupo que se deseja editar.	Inteiro (Integer)
grupoId	Informar o identificador do grupo que referencia ao parâmetro se deseja editar.	Caracteres (String)
valor	Informar o valor que se deseja incluir na edição do parâmetro.	Caracteres (String)

# Compras

# Cadastro de compras

Para cadastrar uma compra, é necessário enviar à API uma requisição com um corpo de solicitação (Request body) contendo a data de início, data de fim, filtro e detalhes da compra, que incluem: documento, data de emissão, valor e identificador da compra.

Método: POST
Endpoint da consulta: /api/v1/compras

Clique para exibir o corpo da requisição

{
  "inicio": "2024-05-02T11:29:21.369Z",
  "fim": "2024-05-02T11:29:21.369Z",
  "tipoFiltro": "string",
  "compras": [
    {
      "documento": "string",
      "dataEmissao": "2024-05-02T11:29:21.369Z",
      "valorCompra": 0,
      "identificadorCompra": "string"
    }
  ]
}

Campos do JSON:

Campo	Descrição	Tipo do Campo
inicio	Informar a data de início da compra.	Data (Date)
fim	Informar a data de fim da compra.	Data (Date)
tipoFiltro	Informar o tipo de filtro da compra.	Caracteres (String)
compras	Informar dados da compra.	Lista de dados
documento	Informar documento que realizará a compra.	Caracteres (String)
dataEmissao	Informar data de emissão da compra.	Data (Date)
valorCompra	Informar valor da compra.	Inteiro (Integer)
identificadorCompra	Informar identificador da compra.	Caracteres (String)

# Cadastro de compras com arquivo

Para cadastrar uma compra utilizando um arquivo CSV, é necessário enviar uma requisição para a API contendo os seguintes parâmetros:

Arquivo: um campo onde é necessário selecionar o arquivo desejado;
Inicio: informe a data de início da compra neste campo;
Fim: informe a data de término da compra neste campo;
TipoFiltro: especifique o tipo de filtro da compra, que pode ser 'EMISSAO' ou 'COMPLETO';
IsIntegracao: um campo onde deve ser selecionado o valor verdadeiro ou falso para indicar se a compra possui integração.

Parâmetros da Consulta:

Campo	Descrição	Tipo do Campo
Arquivo	Informar o arquivo da compra que se deseja cadastrar.	Arquivo csv
Inicio	Informar a data de início da compra.	Data (Date)
Fim	Informar a data de fim da compra.	Data (Date)
TipoFiltro	Informar o filtro da compra.	Caracter (String)

# Buscar erros

Este endpoint é um complemento ao endpoint de cadastro de compras por arquivo mencionado anteriormente. Ele busca o caminho do arquivo que pode conter erros. Tem como único parâmetro um campo onde o usuário deve informar o caminho do arquivo.

Método: GET
Endpoint da consulta: /api/v1/comptras/erro

Parâmetros da Consulta:

Campo	Descrição	Tipo do Campo
FileStoragePath	Informar o caminho do arquivo de compras.	Caracter (String)

# Buscar arquivos de compras

Para buscar um arquivo de compra, é necessário enviar uma requisição para a API contendo os seguintes parâmetros: situações, tipos de envio, filtro, página e tamanho.

Método: GET
Endpoint da consulta: /api/v1/compras/arquivos/paged

Parâmetros da Consulta:

Campo	Descrição	Tipo do Campo
Situacoes	Informar a situação da compra.	Inteiro (Integer)
TiposEnvio	Informar o tipo de envio da compra.	Inteiro (Integer)
Filter	Informar o filtro da compra.	Caracter (String)
Page	Informar qual a página onde se encontra a compra.	Inteiro (Integer)
Size	Informar a quantidade de itens para aparecer no resultado da requisição.	Integer (String)

# Alerta

# Criar alerta

Para realizar o cadastro de um alerta é necessário enviar para a API uma requisição com um Request body contendo um documento e uma mensagem do alerta.

Método: POST
Endpoint da consulta: /api/v1/alerta

Clique para exibir o corpo da requisição

{
  "documento": "string",
  "mensagem": "string"
}

Campos do JSON:

Campo	Descrição	Tipo do Campo
documento	Informar o documento do alerta.	Caracter (String)
mensagem	Informar a mensagem do alerta.	Caracter (String)

# Buscar alertas

Para realizar a busca de uma lista de alertas, é necessário enviar à API uma requisição com os seguintes parâmetros: Filtro, Página e Tamanho.

Método: GET
Endpoint da consulta: /api/v1/alerta

Parâmetros da Consulta:

Campo	Descrição	Tipo do Campo
Filter	Informar o filtro para realizar a consulta dos alertas.	Caracter (String)
Page	Informar a página onde estão localizados os alertas que se deseja consultar.	Inteiro (Integer)
Size	Informar a quantidade de alertas que serão retornados na consulta.	Inteiro (Integer)

# Editar alerta

Para realizar a edição de um alerta, é necessário enviar à API uma requisição com um corpo de solicitação (Request body) contendo o identificador do alerta e se ele está ativo ou não.

Método: PATCH
Endpoint da consulta: /api/v1/alerta

Clique para exibir o corpo da requisição

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ativo": true
}

Campos do Json:

Campo	Descrição	Tipo do Campo
id	Informar o identificador do alerta que se deseja editar.	Caracter (String)
ativo	Informar se o alerta deve estar ativo ou não.	Verdadeiro ou falso (Boolean)

# Consulta

# Busca de consulta

Para realizar a busca de uma consulta, é necessário enviar uma requisição para a API com o documento como único parâmetro.

Método: GET
Endpoint da consulta: /api/v1/consulta/{documento}

Parâmetros da Consulta:

Campo	Descrição	Tipo do Campo
documento	Informar o documento que se deseja fazer uma consulta.	Caracter (String)