Referentielijsten opvragen (templates, skins, valuta's, muziek)

Wat je kunt doen

Vier alleen-lezen endpoints geven de referentielijsten terug waaruit je put bij het configureren van een flipbook. Elk endpoint somt de geldige opties voor een specifieke instelling op, zodat je een ID of naam uit de lijst kunt kiezen en die aan het bijbehorende schrijf-endpoint kunt meegeven:

• List templates — de herbruikbare flipbooktemplates die op je account zijn opgeslagen.
• List skins — de beschikbare viewerskins/-thema's, elk met de bijbehorende achtergrond-URL.
• List currencies — de valuta's die beschikbaar zijn bij het verkopen van een flipbook.
• List background music — de ingebouwde achtergrondmuziektracks die je aan een flipbookviewer kunt koppelen.

Voordat je begint

• Authenticeer met je API-sleutel — meegestuurd als de X-Api-Key-header of als Authorization: Bearer YOUR_API_KEY.
• Basis-URL: https://go.fliplink.me.
• Dit zijn GET-lookups zonder request-body en zonder padparameters — opties worden waar aangegeven als query-strings meegegeven.

List templates

Somt de herbruikbare flipbooktemplates op die op je account zijn opgeslagen. Filter op DocType. Gebruik de ID van een template met de save-as-template- / create-flows.

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

Response:

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

De queryparameter DocType accepteert 0 = Flipbook (standaard) of 1 = Document.

List skins

Somt de beschikbare viewerskins/-thema's op; elke rij bevat de bijbehorende achtergrond-URL van de skin. Gebruik de Name van een skin met set-skin.

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

Response:

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

De queryparameter Type is een boolean: false = Flipbook-skins, true = Document-skins.

List currencies

Somt de valuta's op die beschikbaar zijn bij het verkopen van een flipbook (voor de verkoop-/checkoutinstellingen).

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

Response:

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

List background music

Somt de ingebouwde achtergrondmuziektracks op die je aan een flipbookviewer kunt koppelen.

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

Response:

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

Mogelijke fouten

• Ontbrekende of ongeldige API-sleutel → HTTP 401. Dit geeft een kale Unauthorized-HTML-pagina terug — er is geen JSON-body. Dit geldt voor alle vier de endpoints.