--- title: "Introdução" slug: "introducao-3" updated: 2021-02-01T17:28:00Z published: 2021-02-01T17:28:00Z canonical: "help.hiplatform.com/introducao-3" --- > ## Documentation Index > Fetch the complete documentation index at: https://help.hiplatform.com/llms.txt > Use this file to discover all available pages before exploring further. # Introdução ## Endpoints Para verificar os endpoints disponíveis, por favor, acesse nossa documentação do Swagger: [https://nps.yourviews.com.br/api/v1/swagger](https://nps.yourviews.com.br/api/v1/swagger) Através dessa tela do Swagger, você também pode testar diretamente as chamadas e verificar a documentação dos campos de retorno. ## Autenticação A autenticação é feita através de [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication), utilizando credenciais de usuário e senha. Essas credenciais deverão ser fornecidas pela equipe da Hi Platform. ## Cenários comuns de integração **1 - Tenho um sistema de BI e gostaria de integrar as respostas de NPS com esse sistema. Como devo fazer?** Você deve utilizar o endpoint GET /api/v1/nps. Esse endpoint irá retornar todas as respostas de NPS que você tenha recebido. É importante utilizar os filtros corretamente, principalmente de data. É recomendável que você replique a base de respostas em seu sistema, evitando consultas "on-demand", que podem ser lentas, dependendo da quantidade de resposta que você possui. **2 - Quero disparar pesquisas via API** A forma recomendável é inserir uma nova Pessoa sempre que você quiser que a mesma receba uma pesquisa de NPS. Para isso: a) Crie um nova Campanha no sistema de NPS, através do painel administrativo. Lembre-se de configurar Template de e-mail, formulário de Pesquisa e Lista de Pessoas. b) Nessa Campanha criada, crie um tipo de disparo "Contínuo", que irá enviar e-mail sempre que uma nova Pessoa for recebida. c) Agora você pode chamar o endpoint POST /api/v1/person. Ao receber uma nova pessoa, o sistema irá automaticamente disparar o e-mail de NPS para a pessoa cadastrada. Lembre-se: - No body da requisição ao endpoint você deve informar o TargetLists (nome da Lista de Pessoas criada no passo a); ![image.png](https://cdn.document360.io/fbdc20e9-fffd-4203-8df2-642bdec311ea/Images/Documentation/image%2872%29.png) - Você pode informar uma ou mais Dimensões. Ao responder o NPS, essas dimensões são salvas junto às respostas ![image.png](https://cdn.document360.io/fbdc20e9-fffd-4203-8df2-642bdec311ea/Images/Documentation/image%2873%29.png)