Base URL https://api.afer.pro Referencia aferapp.com Reservar demo

Ver un formulario

GET https://api.afer.pro/api/v1/forms/{id}
Alias en castellano (v0, sigue operativo): GET https://api.afer.pro/api/v1/forms/{formularioId}

Un formulario con sus ajustes y sus preguntas.

Devuelve los ajustes, las preguntas (con su preguntaId, tipo, opciones y escala) y cuántas personas han respondido de las invitadas. Hace falta para editar las preguntas.

Autenticación

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.

formularioIdstring
obligatorio
El formulario (de listarFormularios).

Ejemplo de petición

curl -X GET 'https://api.afer.pro/api/v1/forms/aBc123XyZ' \
  -H 'X-API-KEY: afer_tk_TU_TOKEN' \
  -H 'X-API-SECRET: afer_sk_TU_SECRET'
<?php

$ch = curl_init('https://api.afer.pro/api/v1/forms/aBc123XyZ');
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',
]);

$respuesta = json_decode(curl_exec($ch), true);
curl_close($ch);
const respuesta = await fetch('https://api.afer.pro/api/v1/forms/aBc123XyZ', {
  method: 'GET',
  headers: {
    'X-API-KEY': 'afer_tk_TU_TOKEN',
    'X-API-SECRET': 'afer_sk_TU_SECRET'
  }
});

const resultado = await respuesta.json();

Respuesta

200 · application/json
{
    "errorCode": 200,
    "errorMsg": "",
    "data": {
        "formularioId": "aBc123…",
        "titulo": "Fin del periodo de prueba",
        "estado": "abierto",
        "acceso": "invitacion",
        "confidencial": true,
        "preguntas": [
            {
                "preguntaId": "dEf456…",
                "tipo": "escala",
                "texto": "Cumple las tareas del puesto",
                "obligatoria": true,
                "escala_min": 1,
                "escala_max": 5
            }
        ],
        "participacion": {
            "invitados": 3,
            "respondidas": 1
        }
    }
}