DOCUMENTACIÓN API ENCUESTAS – CSAT
GET (Obtener datos de encuesta) → /api/encuestas/obtener/<hash>
POST (Enviar datos de encuesta) → /api/encuestas/procesar/<hash>Obtener Datos De La Encuesta.
Para obtener las preguntas relacionadas con la encuesta se debe consultar el enpoint GET /api/encuestas/obtener/, donde hash es la cadena de texto provista por el sistema. Esta petición debe ir acompañada de la correspondiente API KEY, que debe ser suministrada el los headers de la petición bajo el nombre ‘key’.
Si el hash enviado es válido obtendrá una respuesta en formato JSON con tres claves:
Nombre: Nombre de la encuesta.
Descripción: Descripción de la encuesta.
Preguntas: Un arreglo con las preguntas correspondientes a la encuesta.
Cada pregunta del arreglo tiene la siguiente forma:
{
"id": "<p-x>",
"tipo": "<A/C/R>",
"pregunta": "¿...?"
}
Id: Identificador único de la pregunta.
Tipo: El tipo de pregunta identifica si la pregunta es abierta, cerrada o rango.
- Abierta (A): Respuesta abierta, pudiendo ser esta una cadena de caracteres.
- Cerrada (C): Respuesta cerrada, pudiendo esta ser solamente SI/NO.
- Rango (R): Respuesta dentro del rango de 1 a 10, pudiendo esta ser un valor comprendido dentro de este.
Pregunta: El texto correspondiente a la pregunta.
🟧 NOTA: Es muy importante tener el cuenta el tipo de pregunta a la hora de enviar los resultado al enpoint correspondiente.
En caso de error, la respuesta tendrá la siguiente forma:
{
"error": true,
"msg": "..."
}Enviar Datos De La Encuesta.
Para enviar el resultado de la encuesta debe mandarse una petición del tipo POST al endpoint /api/encuestas/procesar/<hash>, donde hash es la cadena de texto provista por el sistema. Esta petición debe ir acompañada de la correspondiente API KEY, que debe ser suministrada el los headers de la petición bajo el nombre ‘key’.
El body de la petición debe contener un arreglo donde cada uno de sus elementos tiene que corresponder con una de las respuestas de la encuesta.
Importante, se debe utilizar Google reCaptcha V3. La clave del sitio se le proveerá junto con el API KEY.
[
{
"id": "<p-x>",
"rta": "NO" //Respuesta tipo cerrada.
},
{
"id": "<p-x>",
"rta": "Respuesta abierta" //Respuesta tipo abierta.
},
{
"id": "<p-x>",
"rta": "5" //Respuesta tipo rango.
},
{"id": "recaptcha",
"rta": "HASH_GOOGLE_RECAPTCHA" //SIEMPRE EL ÚLTIMO REGISTRO
}
]Si los datos son correctos se obtendrá como respuesta un código de estado HTTP 201 y un mensaje indicando que la operación se realizo con éxito.
{
"msg": "Encuesta cargada satisfactoriamente"
}En caso de error se obtendrá, además de la debida respuesta, el código de estado HTTP correspondiente al error.
{
"error": true,
"msg": "<mensaje_error>"
}