Flipbooks ordenen met mappen en templates

Wat je kunt doen

Met deze drie endpoints houd je je flipbooks geordend zonder het dashboard aan te raken:

• Bekijk je mappen, elk teruggegeven als een naam en een map-GUID.
• Wijs een flipbook toe aan een map — mappen worden op verzoek aangemaakt, en het meesturen van een lege map haalt de flipbook uit zijn map.
• Sla een flipbook op als herbruikbare template, of haal hem uit je templates.

Voordat je begint

• Een API-sleutel — meegestuurd op elk verzoek als de X-Api-Key-header of als Authorization: Bearer YOUR_API_KEY.
• Alle verzoeken gaan naar de basis-URL https://go.fliplink.me.
• De twee schrijf-endpoints (assign-to-folder en save-as-template) gebruiken een {flipbookId}-padparameter — de numerieke ID van de flipbook, teruggegeven door create-by-file / create-by-url (als ID) of door list.
• Die schrijf-endpoints nemen een form-urlencoded body (geen JSON).

Je mappen bekijken

GET /api/list-folders somt je mappen op, elk als { Folder (naam), URL (een map-GUID) }. Mappen worden afgeleid uit flipbooktoewijzingen, dus een lege map wordt niet vermeld.

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

Response:

{
  "Result": "OK",
  "Items": [
    {
      "Folder": "Marketing",
      "URL": "00000000-0000-0000-0000-000000000001"
    },
    {
      "Folder": "Marketing/Q2",
      "URL": "00000000-0000-0000-0000-000000000002"
    }
  ]
}

Een flipbook aan een map toewijzen

PUT /api/assign-to-folder/{flipbookId} verplaatst de flipbook naar een map. Mappen worden op verzoek aangemaakt — wijs toe aan een mapnaam die nog niet bestaat en die wordt automatisch aangemaakt (er is geen aparte "map aanmaken"-aanroep). Mapnamen mogen / bevatten (bijv. Marketing/Q2). Een map bestaat alleen zolang er minstens één flipbook in zit, dus wanneer je de laatste flipbook eruit haalt, verdwijnt de map uit list-folders.

curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder=Marketing/Q2'

Response:

{
  "Result": "OK",
  "Message": "Folder updated successfully"
}

Om de flipbook uit zijn map te halen, stuur je een lege Folder:

curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder='

Een flipbook opslaan als template

PUT /api/save-as-template/{flipbookId} markeert de flipbook als herbruikbare template (Status=true) of haalt hem uit de templates (Status=false). Templates verschijnen in list-templates en kunnen als basis dienen voor nieuwe flipbooks. Status is standaard true als je het weglaat.

curl -X PUT 'https://go.fliplink.me/api/save-as-template/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Status=true'

Response:

{
  "Result": "OK",
  "Message": "Saved as template"
}

Mogelijke fouten

• Ontbrekende of ongeldige API-sleutel → HTTP 401. Dit geeft een kale Unauthorized-HTML-pagina terug — er is geen JSON-body.
• Item-ID niet gevonden of niet in eigendom van je sleutel (assign-to-folder, save-as-template) → HTTP 200 met Message: "Item not found".
• Onbekend of verkeerd gespeld body-veld (assign-to-folder, save-as-template) → HTTP 200 met Message: "Unknown field(s) '…'. Expected: …".

Opmerkingen

• De Folder-naam die je toewijst, is dezelfde waarde die onder Folder in list-folders verschijnt, dus je kunt een bestaande mapnaam hergebruiken om er meer flipbooks aan toe te voegen.