Saltar a la navegación

Hacer tu primera llamada a la API

La forma más rápida de comprobar si todo funciona es consultar tus listas. Esa llamada no modifica nada en tu cuenta y da una respuesta inmediata. Puedes hacer esta llamada desde este mismo sitio web o desde tu propio ordenador.

Hacer la llamada desde este sitio web

1

Crea una clave API

Crea una clave en tu cuenta en el apartado «Conectar». Una clave nueva solo se muestra una vez, así que guárdala de inmediato. Ver: Crear una clave API.

2

Abre el endpoint

Ve a Obtener todas las listas.

3

Introduce tu clave y envíala

Haz clic a la derecha del ejemplo de código en «Try it» e introduce tu clave en «api_key». Después, haz clic en enviar. Puedes leer más sobre este campo y este botón en Probar la API con Try it.

4

Lee la respuesta

Recibirás una respuesta 200 con todas tus listas en data. Necesitarás el list_id que ves ahí para casi cualquier otra llamada.

Con esto estás haciendo una llamada real. En Probar la API con Try it se explica cómo hacer pruebas de forma segura.

Hacer la llamada desde tu propio sistema

Puedes consultar cómo enviar tu clave en Autenticación con tu clave API.

curl
curl https://api.laposta.nl/v2/list \
-u TU_CLAVE_API:

Con la biblioteca PHP sería así:

PHP
$laposta = new Laposta('TU_CLAVE_API');
$listas = $laposta->listApi()->all();

Una respuesta tiene este aspecto, abreviada a una sola lista:

{
"data": [
{
"list": {
"list_id": "BaImMu3JZA",
"name": "Boletín",
"state": "active",
"members": { "active": 1232, "unsubscribed": 113, "cleaned": 14 }
}
}
]
}

Añadir un suscriptor

La llamada que probablemente necesitarás después es la de añadir un suscriptor. Además de la dirección de correo electrónico, la dirección IP es obligatoria, ya que con ella registras desde dónde se realizó la suscripción.

curl
curl https://api.laposta.nl/v2/member \
-u TU_CLAVE_API: \
-d list_id=BaImMu3JZA \
-d ip=198.51.100.10 \
-d email=nuevo.suscriptor@example.net \
-d custom_fields[nombre]=Lucía
PHP
$laposta->memberApi()->create('BaImMu3JZA', [
'ip' => '198.51.100.10',
'email' => 'nuevo.suscriptor@example.net',
'custom_fields' => ['nombre' => 'Lucía'],
]);

Las claves dentro de custom_fields corresponden al custom_name de tus propios campos. Puedes obtenerlas una sola vez mediante Obtener todos los campos y guardarlas en tu propio código.

Artículos relacionados