API para extração de relatórios.

A API de Web Query permite a extração de relatórios via API com base nas Web Querys do Bseller.

Link Swagger API - DW de Produção: https://api-dw.bseller.com.br/swagger-ui.html

Para extração do relatório é preciso primeiro obter os parâmetros do relatório desejado, e depois executa-lo para obter o relatório em formato JSON ou EXCEL.

Os exemplos citados, foram gerados através do programa POSTMAN.


1- Consultando os parâmetros do relatório.

Na API de Consulta (Consulta parâmetros webquery por código da webquery) é necessário informar o código da WebQuery a qual se deseja extrair os dados, no exemplo em questão foi utilizada a WQ SIGEQ230

Ex: 
http://api-dw.bseller.com.br/webquery/parametros/SIGEQ230

--> Autenticação utilizada no GET de parâmetros e execução em formato JSON. 

Header	Value
X-Auth-Token	"*Use seu Token de autenticação*"
Content-Type	application/json

Após execução da API em modo GET, será retornado os dados (Exemplo):

A API retorna os parâmetros disponíveis referente ao relatório que foi informado na execução.
no exemplo em questão, são eles:

"id": "SIGEQ230",        --> Id do relatório.

"nome": "P_ID_CIA",   --> Descrição do parâmetro (Os nomes dos parâmetros serão utilizados na próxima etapa, onde acontecerá a extração dos dados).

"tamanho": 9,             --> Quantidade máxima de caracteres.

"tipo": "NUM",            --> Tipo de dado. (Num, Data...)

"obrigatorio": true     --> Informa se o parâmetro tem preenchimento obrigatório ou não na execução do relatório ("true" ou "false").

2 - Executando o relatório.

2.1 Retorno de dados na API (JSON).

Acesse a API (Execução da webquery retornando listagem) e informe o id do relatório a ser executado.

Método POST :  http://api-dw.bseller.com.br/webquery/execute/SIGEQ230

BODY (Corpo da API):
É preciso ser preenchido com os parâmetros que foram obtidos na chamada da API anterior "Consulta parâmetros webquery por código da webquery".
Lembrando que nessa execução serão utilizados os nomes dos parâmetros, e mesmo os parâmetros que não são obrigatórios, devem ser colocados no body, caso não queira usar um determinado parâmetro de busca, apenas informe nele o valor null
 
Exemplo:
{
"parametros": {

"P_ID_CIA": 00000,
"P_ID_CONITE":1,
"P_ID_DEPART":1,
"P_ID_FORNEC":52135653000181,
"P_DT_INCL_INI": "20/09/2019",
"P_DT_INCL_FIM": "01/10/2019"
}
  }

Clique em "Send":

 Erros :
Caso o parâmetro esteja incorreto, ou seja obrigatório e não for informado, serão exibidas mensagens de erro.
exemplo:
--> Não foi informado um parâmetro obrigatório "P_ID_CIA".

--> Foi informado um parâmetro incorreto, (Ao invés de informar que o parâmetro "P_ID_DEPART" tem o valor "1", foi informado o valor "A")

--> Nos relatórios que possuem parâmetro de DATA ("P_DT_INCL_INI" e "P_DT_INCL_FIM") é obrigatório que a data mais antiga fique no campo "P_DT_INCL_INI" e a mais recente no campo "P_DT_INCL_FIM", senão o relatório não trará os dados solicitados.

 2.2 Retorno de dados em formato Excel.

Para execução em formato excel o body permanece o mesmo do exemplo anterior, sendo necessário alterar apenas o link da api e o modelo de autenticação.

--> Autenticação utilizada para retornar dados em formato de arquivo Excel.

Header	Value
X-Auth-Token	"*Use seu Token de autenticação*"
Accept	application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Com os parâmetros adquiridos, acesse a API  "Execução da webquery retornando excel"
executando uma chamada do tipo POST informando os parâmetros adquiridos.

 http://api-dw.bseller.com.br/webquery/execute-excel/SIGEQ230

Clique na seta ao lado do botão "Send" e selecione "Send and Download"

 Após execução será realizado o download do relatório em formato de arquivo Excel.