Crear un formulario
https://api.afer.pro/api/v1/forms
POST https://api.afer.pro/api/v1/forms
Un formulario nuevo, desde una plantilla o con tus preguntas. Nace en borrador.
Plantillas: satisfaccion_cliente (público, con NPS), clima_empleados (para la plantilla, anónimo), periodo_prueba (evaluación por invitación, confidencial) y en_blanco. Si mandas preguntas, sustituyen a las de la plantilla; el resto de ajustes que mandes manda sobre los suyos.
Tipos de pregunta: texto, parrafo, opcion, multiple, desplegable, escala, si_no, numero, fecha, email.
Nace en borrador (nadie puede responder) salvo que pidas estado = abierto.
Envía tus claves API en las cabeceras X-API-KEY y X-API-SECRET. La cuenta sobre la que se opera se resuelve automáticamente a partir de la clave. Cómo obtener tus claves →
Este endpoint requiere autenticación. La empresa tiene que tener el módulo de formularios activado (si no, 403). A nombre de una persona, como en el panel: administración y RRHH; los confidenciales, solo RRHH y quien los creó.
Parámetros del cuerpo
El cuerpo de la petición es un objeto JSON con Content-Type: application/json.
titulostringopcional | Título. Con plantilla, por defecto el suyo. |
plantillastringopcional | Plantilla de partida. |
preguntasarrayopcional | [{tipo, texto, ayuda, obligatoria, opciones, escala_min, escala_max, etiqueta_min, etiqueta_max, ref, mostrar_si, ir_a, despues}]. Flujo: tipo: "seccion" parte el formulario en pasos; mostrar_si: {modo: "todas"|"alguna", reglas: [{pregunta: ref|"#3", op, valor}]} (op: es, no_es, contiene, mayor, menor, respondida, no_respondida) enseña una pregunta según respuestas anteriores; ir_a: {"Sí": "ref_de_seccion", "No": "fin"} (en opcion, desplegable y si_no) y despues (en las secciones) llevan a una sección posterior o a enviar. |
accesostringopcional | publico, empresa o invitacion. |
anonimoboolopcional | No guardar quién respondió. |
pedir_datosstringopcional | Públicos no anónimos: no, opcional u obligatorio. |
una_por_personaboolopcional | Acceso empresa: una respuesta por persona. |
confidencialboolopcional | Respuestas solo para RRHH y quien lo creó. |
estadostringopcional | borrador (por defecto), abierto o cerrado. |
fecha_cierrestringopcional | YYYY-MM-DD o YYYY-MM-DD HH:MM. |
descripcionstringopcional | Presentación o instrucciones. |
mensaje_graciasstringopcional | Lo que se ve al terminar. |
Ejemplo de petición
curl -X POST 'https://api.afer.pro/api/v1/forms' \
-H 'X-API-KEY: afer_tk_TU_TOKEN' \
-H 'X-API-SECRET: afer_sk_TU_SECRET' \
-H 'Content-Type: application/json' \
-d '{
"plantilla": "satisfaccion_cliente",
"titulo": "Satisfacción de clientes · octubre",
"anonimo": false,
"pedir_datos": "opcional"
}'
<?php
$data = [
'plantilla' => 'satisfaccion_cliente',
'titulo' => 'Satisfacción de clientes · octubre',
'anonimo' => false,
'pedir_datos' => 'opcional',
];
$ch = curl_init('https://api.afer.pro/api/v1/forms');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'X-API-KEY: afer_tk_TU_TOKEN',
'X-API-SECRET: afer_sk_TU_SECRET',
'Content-Type: application/json',
]);
$respuesta = json_decode(curl_exec($ch), true);
curl_close($ch);
const respuesta = await fetch('https://api.afer.pro/api/v1/forms', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-KEY': 'afer_tk_TU_TOKEN',
'X-API-SECRET': 'afer_sk_TU_SECRET'
},
body: JSON.stringify({
"plantilla": "satisfaccion_cliente",
"titulo": "Satisfacción de clientes · octubre",
"anonimo": false,
"pedir_datos": "opcional"
})
});
const resultado = await respuesta.json();
Respuesta
{
"errorCode": 200,
"errorMsg": "",
"data": {
"formularioId": "aBc123…",
"titulo": "Satisfacción de clientes · octubre",
"estado": "borrador",
"acceso": "publico",
"enlace": "https://prosuite.aferapp.com/formulario/?f=…",
"num_preguntas": 4,
"siguiente_paso": "Está en borrador: nadie puede responderlo hasta que lo abras."
}
}