Ricerche di riferimento (template, skin, valute, musica)

Cosa puoi fare

Quattro endpoint di sola lettura restituiscono gli elenchi di riferimento a cui attingi quando configuri un flipbook. Ognuno elenca le opzioni valide per un'impostazione specifica, così puoi scegliere un ID o un nome dall'elenco e passarlo all'endpoint di scrittura corrispondente:

• List templates — i template di flipbook riutilizzabili salvati sul tuo account.
• List skins — le skin/i temi del viewer disponibili, ognuno con l'URL del proprio sfondo abbinato.
• List currencies — le valute disponibili quando vendi un flipbook.
• List background music — le tracce di musica di sottofondo integrate che puoi collegare a un viewer di flipbook.

Prima di iniziare

• Autenticati con la tua chiave API — inviata come header X-Api-Key o come Authorization: Bearer YOUR_API_KEY.
• URL di base: https://go.fliplink.me.
• Queste sono ricerche GET senza body di richiesta e senza parametri nel percorso — le opzioni vengono passate come query string dove indicato.

List templates

Elenca i template di flipbook riutilizzabili salvati sul tuo account. Filtra per DocType. Usa l'ID di un template con i flussi save-as-template / create.

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

Risposta:

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

Il parametro di query DocType accetta 0 = Flipbook (predefinito) o 1 = Document.

List skins

Elenca le skin/i temi del viewer disponibili; ogni riga contiene l'URL dello sfondo abbinato alla skin. Usa il Name di una skin con set-skin.

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

Risposta:

{
  "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"
    }
  ]
}

Il parametro di query Type è un boolean: false = skin per Flipbook, true = skin per Document.

List currencies

Elenca le valute disponibili quando vendi un flipbook (per le impostazioni di vendita/checkout).

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

Risposta:

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

List background music

Elenca le tracce di musica di sottofondo integrate che puoi collegare a un viewer di flipbook.

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

Risposta:

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

Errori possibili

• Chiave API mancante o non valida → HTTP 401. Restituisce una semplice pagina HTML di Unauthorized — non c'è alcun body JSON. Questo vale per tutti e quattro gli endpoint.