Gestionar la lista de correos permitidos de un flipbook

Qué puedes hacer

Cuando un flipbook está restringido por correo, solo las direcciones de su lista de permitidos pueden abrirlo. La API te da cuatro formas de gestionar esa lista sin tocar nunca el panel:

• Lee la lista actual, para que nunca tengas que llevar tú el control.
• Agrega una o varias direcciones (sin alterar las que ya están).
• Elimina direcciones concretas.
• Reemplaza la lista entera en una sola llamada.

Esta guía recorre cada una, la forma exacta de la solicitud, las respuestas que recibes y el detalle que más confunde (la diferencia entre agregar y reemplazar).

Antes de empezar

Vas a necesitar:

• Una clave de API — se envía en el encabezado X-Api-Key en cada solicitud. (Tu clave está en la página de API de tu cuenta).
• El flipbookId de un flipbook que esté restringido por correo. La lista de permitidos rige el acceso del visor en los flipbooks restringidos por correo.
• Todas las solicitudes van a la URL base https://go.fliplink.me.

El campo EmailsAllowed en las solicitudes de escritura es form-urlencoded (no JSON) y va separado por punto y coma (alice@corp.com;bob@corp.com). Las comas se aceptan y se convierten en punto y coma automáticamente.

Los cuatro endpoints de un vistazo

Lee la lista actual

Empieza siempre aquí: lee la lista para conocer su estado exacto antes de cambiar nada.

curl -X GET 'https://go.fliplink.me/api/get-email-allow-list/96464' \
  -H 'X-Api-Key: YOUR_API_KEY'

Respuesta:

{ "Result": "OK", "EmailsAllowed": ["alice@corp.com", "bob@corp.com"], "Count": 2 }

EmailsAllowed vuelve como un array JSON limpio (no como una cadena separada por punto y coma), y Count es su longitud.

Agrega direcciones (sin borrar el resto)

Para dar acceso a gente nueva conservando a todos los que ya están en la lista, usa Add. Es aditivo: no elimina a nadie.

curl -X POST 'https://go.fliplink.me/api/add-email-allow-list/96464' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed=carol@corp.com;dan@corp.com'

Respuesta (la lista completa y actualizada):

{ "Result": "OK", "EmailsAllowed": ["alice@corp.com", "bob@corp.com", "carol@corp.com", "dan@corp.com"], "Count": 4 }

Elimina direcciones concretas

Para revocar el acceso a personas concretas, usa Delete. Solo se eliminan las direcciones que indicas; el resto se queda.

curl -X DELETE 'https://go.fliplink.me/api/delete-email-allow-list/96464' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed=carol@corp.com'

Respuesta:

{ "Result": "OK", "EmailsAllowed": ["alice@corp.com", "bob@corp.com", "dan@corp.com"], "Count": 3 }

Reemplaza la lista entera ⚠️

Set sobrescribe toda la lista de permitidos con exactamente las direcciones que envías. Aquí está el detalle traicionero: enviar una sola dirección borra a todos los demás.

# Esto NO agrega una persona — deja la lista SOLO con esa persona.
curl -X PUT 'https://go.fliplink.me/api/set-email-allow-list/96464' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed=alice@corp.com'

Tras esta llamada, alice@corp.com es la única dirección que puede ver el flipbook. Usa Set solo cuando de verdad quieras definir la lista completa desde cero (por ejemplo, para inicializar un flipbook nuevo). Para los cambios cotidianos de "dar acceso a esta persona / revocarlo a aquella", usa Add y Delete en su lugar.

Para vaciar la lista por completo, envía un valor vacío:

curl -X PUT 'https://go.fliplink.me/api/set-email-allow-list/96464' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed='

Errores posibles

• Clave de API ausente o no válida → HTTP 401. Esto devuelve una página HTML de "Unauthorized" sin formato — no hay cuerpo JSON. Comprueba que el encabezado X-Api-Key esté presente y sea correcto.
• flipbookId desconocido (o uno que tu clave no posee) → HTTP 200 con { "Result": "ERROR", "Message": "Item not found" }.

Una regla práctica rápida: Result: "OK" significa que el cambio se aplicó; Result: "ERROR" significa que no se aplicó — lee el Message para saber el motivo.

Patrón recomendado

Para cambios seguros y predecibles:

1. GET de la lista actual.
2. Decide a quién agregar o eliminar.
3. Usa Add / Delete para cambios puntuales (nunca alteran el resto de la lista).
4. Reserva Set para cuando de verdad quieras reemplazar la lista entera de una vez.
5. GET de nuevo para confirmar el estado final.

Este ciclo de "leer → cambiar → volver a leer" hace que nunca tengas que llevar el control de la lista en tu propio sistema, y que nunca borres el acceso por accidente al usar Set cuando querías Add.