Envíos automáticos programados
GET
https://api.afer.pro/api/v1/forms/schedules
Alias en castellano (v0, sigue operativo):
GET https://api.afer.pro/api/v1/forms/schedules
Las reglas de envío automático, con cuántos enlaces han salido y cuántos se han respondido.
De un formulario (formularioId) o de todos los que puedes ver.
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.
formularioIdstringopcional | Solo los de este formulario. |
Ejemplo de petición
curl -X GET 'https://api.afer.pro/api/v1/forms/schedules' \
-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/schedules');
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/schedules', {
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": {
"total": 1,
"envios": [
{
"envioId": "aBc123…",
"regla": "7 días antes de acabar el periodo de prueba · a su responsable, sobre la persona · Taller",
"activo": true,
"enlaces": 4,
"respondidos": 3
}
]
}
}