Listes de référence (modèles, habillages, devises, musique)

Ce que tu peux faire

Quatre endpoints en lecture seule renvoient les listes de référence sur lesquelles tu t'appuies pour configurer un flipbook. Chacun liste les options valides pour un paramètre précis : tu peux ainsi choisir un ID ou un nom dans la liste et le transmettre à l'endpoint d'écriture correspondant :

• Lister les modèles — les modèles de flipbook réutilisables enregistrés sur ton compte.
• Lister les habillages — les habillages/thèmes du lecteur disponibles, chacun avec l'URL de son arrière-plan intégré.
• Lister les devises — les devises disponibles pour vendre un flipbook.
• Lister les musiques de fond — les pistes de musique de fond intégrées que tu peux associer au lecteur d'un flipbook.

Avant de commencer

• Authentifie-toi avec ta clé d'API — envoyée soit dans l'en-tête X-Api-Key, soit sous la forme Authorization: Bearer YOUR_API_KEY.
• URL de base : https://go.fliplink.me.
• Ce sont des requêtes GET sans corps ni paramètre de chemin — les options se passent en query string là où c'est indiqué.

Lister les modèles

Liste les modèles de flipbook réutilisables enregistrés sur ton compte. Filtre par DocType. Utilise l'ID d'un modèle dans les flux save-as-template / create.

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

Réponse :

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

Le paramètre de requête DocType accepte 0 = Flipbook (par défaut) ou 1 = Document.

Lister les habillages

Liste les habillages/thèmes du lecteur disponibles ; chaque ligne porte l'URL de l'arrière-plan intégré de l'habillage. Utilise le Name d'un habillage avec set-skin.

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

Réponse :

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

Le paramètre de requête Type est un booléen : false = habillages Flipbook, true = habillages Document.

Lister les devises

Liste les devises disponibles pour la vente d'un flipbook (pour les paramètres de vente/paiement).

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

Réponse :

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

Lister les musiques de fond

Liste les pistes de musique de fond intégrées que tu peux associer au lecteur d'un flipbook.

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

Réponse :

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

Erreurs possibles

• Clé d'API manquante ou invalide → HTTP 401. Renvoie une simple page HTML « Unauthorized » — sans corps JSON. Cela s'applique aux quatre endpoints.