Consultas de referencia (plantillas, skins, monedas, música)

Qué puedes hacer

Cuatro endpoints de solo lectura devuelven las listas de referencia que usas al configurar un flipbook. Cada uno enumera las opciones válidas para un ajuste específico, así que puedes elegir un ID o un nombre de la lista y pasarlo al endpoint de escritura correspondiente:

• Listar plantillas — las plantillas de flipbook reutilizables guardadas en tu cuenta.
• Listar skins — los skins/temas del visor disponibles, cada uno con su URL de fondo incluida.
• Listar monedas — las monedas disponibles al vender un flipbook.
• Listar música de fondo — las pistas de música de fondo integradas que puedes adjuntar al visor de un flipbook.

Antes de empezar

• Autentícate con tu clave de API — se envía como el encabezado X-Api-Key o como Authorization: Bearer YOUR_API_KEY.
• URL base: https://go.fliplink.me.
• Son consultas GET sin cuerpo de solicitud ni parámetros de ruta — las opciones se pasan como cadenas de consulta donde se indica.

Listar plantillas

Enumera las plantillas de flipbook reutilizables guardadas en tu cuenta. Filtra por DocType. Usa el ID de una plantilla con los flujos de save-as-template / create.

curl -X GET 'https://go.fliplink.me/api/list-templates?DocType=0' \
  -H 'X-Api-Key: YOUR_API_KEY'

Respuesta:

{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "- Blank Template - "
    }
  ]
}

El parámetro de consulta DocType acepta 0 = Flipbook (por defecto) o 1 = Document.

Listar skins

Enumera los skins/temas del visor disponibles; cada fila lleva la URL de fondo incluida del skin. Usa el Name de un skin con set-skin.

curl -X GET 'https://go.fliplink.me/api/list-skins?Type=false' \
  -H 'X-Api-Key: YOUR_API_KEY'

Respuesta:

{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "Light Wood",
      "ImageURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/1.webp",
      "ThumbURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/thumb/1.webp"
    }
  ]
}

El parámetro de consulta Type es un booleano: false = skins de Flipbook, true = skins de Document.

Listar monedas

Enumera las monedas disponibles al vender un flipbook (para los ajustes de venta/checkout).

curl -X GET 'https://go.fliplink.me/api/list-currencies' \
  -H 'X-Api-Key: YOUR_API_KEY'

Respuesta:

{
  "Result": "OK",
  "Items": [
    {
      "Name": "AED"
    }
  ]
}

Listar música de fondo

Enumera las pistas de música de fondo integradas que puedes adjuntar al visor de un flipbook.

curl -X GET 'https://go.fliplink.me/api/list-background-music' \
  -H 'X-Api-Key: YOUR_API_KEY'

Respuesta:

{
  "Result": "OK",
  "Items": [
    {
      "Name": "None",
      "FileURL": ""
    }
  ]
}

Errores posibles

• Clave de API ausente o no válida → HTTP 401. Esto devuelve una página HTML de "Unauthorized" sin formato sin cuerpo JSON. Esto aplica a los cuatro endpoints.