Flipbooks mit Ordnern und Vorlagen organisieren

Was du tun kannst

Mit diesen drei Endpunkten hältst du deine Flipbooks geordnet, ohne das Dashboard zu öffnen:

• Auflisten deiner Ordner, jeder zurückgegeben als Name und Ordner-GUID.
• Zuweisen eines Flipbooks zu einem Ordner – Ordner werden bei Bedarf angelegt, und wenn du einen leeren Ordner sendest, wird das Flipbook aus seinem Ordner entfernt.
• Speichern eines Flipbooks als wiederverwendbare Vorlage oder Entfernen aus deinen Vorlagen.

Bevor du loslegst

• Einen API-Schlüssel – wird bei jeder Anfrage entweder als X-Api-Key-Header oder als Authorization: Bearer YOUR_API_KEY gesendet.
• Alle Anfragen gehen an die Basis-URL https://go.fliplink.me.
• Die beiden Schreib-Endpunkte (assign-to-folder und save-as-template) verwenden einen {flipbookId}-Pfadparameter – die numerische ID des Flipbooks, zurückgegeben von create-by-file / create-by-url (als ID) oder von list.
• Diese Schreib-Endpunkte nehmen einen form-urlencoded Body entgegen (kein JSON).

Deine Ordner auflisten

GET /api/list-folders listet deine Ordner auf, jeden als { Folder (Name), URL (eine Ordner-GUID) }. Ordner werden aus Flipbook-Zuweisungen abgeleitet, daher wird ein leerer Ordner nicht aufgeführt.

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

Antwort:

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

Ein Flipbook einem Ordner zuweisen

PUT /api/assign-to-folder/{flipbookId} verschiebt das Flipbook in einen Ordner. Ordner werden bei Bedarf angelegt – weise einem Ordnernamen zu, der noch nicht existiert, und er wird automatisch angelegt (es gibt keinen separaten Aufruf zum „Ordner anlegen“). Ordnernamen dürfen / enthalten (z. B. Marketing/Q2). Ein Ordner existiert nur, solange mindestens ein Flipbook darin liegt, deshalb lässt das Herausnehmen des letzten Flipbooks den Ordner aus list-folders verschwinden.

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

Antwort:

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

Um das Flipbook aus seinem Ordner zu entfernen, sende ein leeres Folder:

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

Ein Flipbook als Vorlage speichern

PUT /api/save-as-template/{flipbookId} markiert das Flipbook als wiederverwendbare Vorlage (Status=true) oder entfernt es aus den Vorlagen (Status=false). Vorlagen erscheinen in list-templates und können neue Flipbooks vorbelegen. Status ist standardmäßig true, wenn es weggelassen wird.

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

Antwort:

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

Mögliche Fehler

• Fehlender oder ungültiger API-Schlüssel → HTTP 401. Das gibt eine reine Unauthorized-HTML-Seite zurück – es gibt keinen JSON-Body.
• Item-ID nicht gefunden oder nicht im Besitz deines Schlüssels (assign-to-folder, save-as-template) → HTTP 200 mit Message: "Item not found".
• Unbekanntes oder falsch geschriebenes Body-Feld (assign-to-folder, save-as-template) → HTTP 200 mit Message: "Unknown field(s) '…'. Expected: …".

Hinweise

• Der Folder-Name, den du zuweist, ist derselbe Wert, der unter Folder in list-folders erscheint, sodass du einen bestehenden Ordnernamen wiederverwenden kannst, um weitere Flipbooks hinzuzufügen.