Conhecendo a API de relatório customizado

Produto afetado: CRM                 Versão: 1.0                        Data de publicação: 04/11/2024

Para publicar uma atualização, insira a nova versão do documento acima do título.

Descrição

A API de Relatório Customizado foi criada para atender clientes que necessitam de consultas específicas com dados limitados ou informações que não estão disponíveis nas APIs nativas da Hypnobox.

Esse serviço permite a criação de relatórios personalizados de acordo com as necessidades de cada cliente, incluindo a aplicação de filtros e regras customizadas em cada consulta. Cada cliente pode ter diferentes consultas personalizadas para acessar via API. Essas consultas são desenvolvidas em parceria com os times de Suporte e Engenharia.

O acesso às consultas é configurável por usuário, permitindo que a empresa tenha várias consultas disponíveis, mas com a flexibilidade de definir quais usuários poderão acessá-las. Isso é feito por meio da atribuição de um relacionamento USUÁRIO x CONSULTA para cada consulta.

Solicitando uma API de relatório customizado

Para solicitar uma API de Relatório Customizado, entre em contato com o time de suporte pelo e-mail suporte@hypnobox.com.br. Especifique os dados que você precisa e o objetivo da consulta. O time de suporte reunirá as informações necessárias para avaliar e construir a consulta personalizada. 

Consumindo uma API de relatório customizado

Se você já possui acesso à API, utilize o Swagger para acessar a documentação e a biblioteca de APIs necessárias para consumo via Web ou para importação em ferramentas como Postman, Insomnia, entre outras. O host para as consultas também será disponibilizado no Swagger.

1° Passo – Autenticação

No endpoint de autenticação (/api/Login/Authenticate), forneça as seguintes credenciais:

• E-mail: seu login no CRM
• Senha: sua senha do CRM
• Empresa: subdomínio do ambiente

Após a autenticação, você receberá um Bearer Token, que deve ser usado no header das suas requisições.

2° Passo – Listar Relatórios Disponíveis

Para visualizar os relatórios disponíveis para seu usuário, utilize o endpoint de relatório customizado (/api/RelatorioCustomizado/RelatoriosUsuario) com uma requisição GET. A resposta incluirá:

• ID da consulta
• Nome da consulta
• Descrição da consulta

A quantidade de consultas acessíveis varia conforme as permissões atribuídas ao usuário pela empresa.

Se precisar de acesso a uma consulta adicional, entre em contato com o Administrador.

3° Passo – Consumindo um Relatório

Para consumir um relatório, siga estas instruções no endpoint (/api/RelatorioCustomizado) :

1. Inclua o Bearer Token obtido no 1° passo no header de todas as requisições.
2. Na querystring, forneça o ID do relatório desejado.

Caso a consulta exija campos obrigatórios, preencha esses campos no corpo da requisição (body), conforme informado na listagem de relatórios do 2° passo.

Os dados retornados são paginados, permitindo que você navegue entre as páginas conforme os métodos de paginação disponíveis no Swagger.

Sempre que uma nova consulta for liberada, o time de tecnologia fornecerá instruções específicas sobre como consumi-la.