📊 API de Pesquisa de Satisfação

Documentação completa para criação de pesquisas e registro de respostas

Este documento explica como usar dois endpoints da API: um para criar uma nova pesquisa de satisfação e outro para registrar a resposta de um usuário a essa pesquisa.

1Criando uma Nova Pesquisa de Satisfação

Para começar, precisamos criar a estrutura da pesquisa. Usamos uma chamada para o endpoint /api/PesquisaSatisfacao para fazer isso.

📤 A Requisição (O que enviamos)

A requisição é um comando curl que faz uma chamada POST para a API. Pense nisso como preencher e enviar um formulário para o servidor.

Comando cURL
curl --location 'http://localhost:5266/api/PesquisaSatisfacao' \
--header 'accept: */*' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOi...xuQ' \
--data '{
  "nome": "Pesquisa de Satisfação 2030",
  "url": "https://exemplo.com/pesquisa",
  "inativo": 0,
  "dataInicio": "2025-10-16T17:46:26.014Z",
  "dataFim": "2025-10-16T17:46:26.014Z",
  "urlAgradecimento": "https://exemplo.com/obrigado"
}'

🔍 O que cada parte significa?

📋 Detalhes do Payload

Campo Descrição
nome O título da sua pesquisa
url O link onde o formulário da pesquisa estará disponível
inativo Indicador se a pesquisa está ativa ou não (0 = inativa, 1 = ativa)
dataInicio Data de início da pesquisa
dataFim Data de término da pesquisa
urlAgradecimento Página que o usuário verá após responder

📥 A Resposta de Sucesso (O que recebemos de volta)

Se tudo der certo, o servidor responderá com o código 201 Created, que significa "Recurso criado com sucesso!"

Ele também devolverá os dados da pesquisa que acabamos de criar, incluindo informações geradas pelo sistema.

Resposta JSON
{
  "id": 4,
  "createdBy": 84002,
  "createdOn": "2025-10-16T14:47:02.7708996-03:00",
  "nome": "Pesquisa de Satisfação 2030",
  "url": "https://exemplo.com/pesquisa",
  "inativo": 0,
  "dataInicio": "2025-10-16T17:46:26.014Z",
  "dataFim": "2025-10-16T17:46:26.014Z",
  "urlAgradecimento": "https://exemplo.com/obrigado"
}
⚠️ Importante: O campo "id": 4 é o identificador único da nova pesquisa. Guarde este valor! Vamos precisar dele para o próximo passo.

2Registrando a Resposta de um Usuário

Agora que a pesquisa foi criada (com id = 4), podemos registrar a resposta de um usuário a ela. Para isso, usamos o endpoint /api/PesquisaSatisfacaoUsuario.

📤 A Requisição (O que enviamos)

A estrutura é parecida, mas agora estamos enviando os dados da resposta de um usuário específico.

Comando cURL
curl --location 'http://localhost:5266/api/PesquisaSatisfacaoUsuario' \
--header 'accept: */*' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOi...xuQ' \
--data '{
  "pesquisaSatisfacaoId": 4,
  "usuarioId": 1,
  "motivo": "não gostei de não gostar a não gostância"
}'

📋 Detalhes do Payload

Campo Descrição
pesquisaSatisfacaoId ID da pesquisa criada no passo anterior (neste caso, 4)
usuarioId Identificador do usuário que está respondendo
motivo Texto com o feedback ou resposta do usuário (não obrigatório)

📥 A Resposta de Sucesso (O que recebemos de volta)

Se a resposta for registrada com sucesso, o servidor retornará o código 201 Created e os dados da resposta que foi salva.

Resposta JSON
{
  "id": 3,
  "createdBy": 84002,
  "createdOn": "2025-10-16T14:47:37.1861173-03:00",
  "pesquisaSatisfacaoId": 4,
  "usuarioId": 1,
  "respondeu": 1,
  "motivo": "não gostei de não gostar a não gostância"
}

Esta resposta confirma que o feedback do usuário com id = 1 para a pesquisa id = 4 foi salvo com sucesso no banco de dados.

O campo "respondeu": 1 serve como uma confirmação (1 = sim/verdadeiro).

🔄 Fluxo Completo

Resumo do Processo

  1. Criar a pesquisa usando POST /api/PesquisaSatisfacao
  2. Guardar o id retornado na resposta
  3. Registrar respostas usando POST /api/PesquisaSatisfacaoUsuario com o pesquisaSatisfacaoId
  4. Receber confirmação de que a resposta foi salva