Enlaces personales
https://api.afer.pro/api/v1/forms/{id}/invitations
POST https://api.afer.pro/api/v1/forms/{formularioId}/invitations
Un enlace para cada persona, opcionalmente sobre alguien; y si quieres, por correo.
A personas de la empresa (nombre, correo o usuarioId) o correos de fuera. Cada enlace vale una vez y deja saber quién ha respondido (en los anónimos, sin saber qué). Con sobre, la respuesta queda ligada a esa persona: p. ej. el responsable evalúa a quien acaba el periodo de prueba.
Con enviar_correo, en dos pasos: sin confirmar devuelve a quién se enviaría y no hace nada; con confirmar = true, crea y envía. El formulario tiene que estar 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.
formularioIdstringobligatorio | El formulario. |
paraarrayopcional | Personas o correos. |
filtroobjectopcional | En vez de (o además de) para: {departamentos, incorporados_desde, incorporados_hasta}. |
sobrestringopcional | Sobre quién (persona de la empresa o texto). |
enviar_correoboolopcional | Enviar el enlace por correo. |
confirmarboolopcional | Confirma el envío. |
Ejemplo de petición
curl -X POST 'https://api.afer.pro/api/v1/forms/aBc123XyZ/invitations' \
-H 'X-API-KEY: afer_tk_TU_TOKEN' \
-H 'X-API-SECRET: afer_sk_TU_SECRET' \
-H 'Content-Type: application/json' \
-d '{
"para": [
"Marta Soler"
],
"sobre": "Pau Riera",
"enviar_correo": true,
"confirmar": true
}'
<?php
$data = [
'para' => [
0 => 'Marta Soler',
],
'sobre' => 'Pau Riera',
'enviar_correo' => true,
'confirmar' => true,
];
$ch = curl_init('https://api.afer.pro/api/v1/forms/aBc123XyZ/invitations');
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/aBc123XyZ/invitations', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-KEY': 'afer_tk_TU_TOKEN',
'X-API-SECRET': 'afer_sk_TU_SECRET'
},
body: JSON.stringify({
"para": [
"Marta Soler"
],
"sobre": "Pau Riera",
"enviar_correo": true,
"confirmar": true
})
});
const resultado = await respuesta.json();
Respuesta
{
"errorCode": 200,
"errorMsg": "",
"data": {
"formulario": "Fin del periodo de prueba",
"estado": "abierto",
"enlaces": [
{
"para": "Marta Soler",
"email": "marta@empresa-ejemplo.es",
"enlace": "https://prosuite.aferapp.com/formulario/?f=…&i=…",
"sobre": "Pau Riera",
"enviado": true
}
]
}
}