Omslagpagina's, verlopen van links en vastpinnen

Wat je kunt doen

Met deze vijf endpoints beheer je de omslagpagina's van een flipbook, het verlopen van zijn link en of hij is vastgepind — zonder het dashboard aan te raken:

• Voeg voor- en/of achteromslagpagina's toe vanuit een geüpload PDF-bestand.
• Voeg voor- en/of achteromslagpagina's toe vanuit een externe PDF-URL.
• Wis de voor-/achterwikkel, waarmee de flipbook wordt teruggezet naar zijn ongewikkelde kern-PDF.
• Stel in of verwijder een automatisch verlopen op de flipbook.
• Pin of ontpin de flipbook zodat hij bovenaan je dashboard wordt gesorteerd.

Voordat je begint

• Een API-sleutel — meegestuurd als de X-Api-Key-header, of als Authorization: Bearer YOUR_API_KEY, op elk verzoek.
• Elk endpoint hier neemt de {flipbookId}-padparameter — de numerieke ID van de flipbook, teruggegeven door create-by-file / create-by-url (als ID) of door list. De voorbeelden hieronder gebruiken 96216.
• Alle verzoeken gaan naar de basis-URL https://go.fliplink.me.
• De endpoints voor de URL-omslagpagina en set-expiry sturen een form-urlencoded body (geen JSON). Het endpoint voor de bestandsomslagpagina stuurt multipart form-data (bestandsuploads). De endpoints clear en pin nemen geen body.

Voor-/achteromslagpagina's instellen vanuit een bestand

Voeg voor- en/of achterpagina's toe vanuit geüploade PDF-bestanden. Zowel Front als Back zijn optioneel — minstens één is verplicht. De pagina's worden opnieuw samengevoegd met de bestaande hoofd-PDF.

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'Front=@/path/to/file' \
  -F 'Back=@/path/to/file'

Response:

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Voor-/achteromslagpagina's instellen vanuit een URL

De URL-variant van het bovenstaande — voegt voor-/achterpagina's toe vanuit een externe PDF-URL in plaats van een geüpload bestand. De velden Front en Back worden form-urlencoded meegestuurd.

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page-by-url/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Front=https://example.com/front.pdf' \
  --data-urlencode 'Back=https://example.com/back.pdf'

Response:

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Voor-/achteromslagpagina's wissen

Verwijdert de voor-/achterwikkel en zet FilePDF terug naar de ongewikkelde kern-PDF (MiddlePDF). Het is idempotent — een flipbook zonder wikkel geeft OK terug en verandert niets. De response bevat de S3-URL van de herstelde kern-PDF. Oude samengevoegde/voor-/achter-S3-objecten worden niet verwijderd. Neemt geen body.

curl -X PUT 'https://go.fliplink.me/api/clear-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Response:

{
  "Result": "OK",
  "Message": "Pages updated successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Verlopen instellen of verwijderen

Stelt het automatisch verlopen van een flipbook in of verwijdert het. Stuur Days en Hours als gehele getallen. Hours is optioneel en is standaard 0. Met Days=-1, Hours=0 verwijder je het verlopen helemaal.

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=7' \
  --data-urlencode 'Hours=12'

Response:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Om het verlopen te verwijderen, stuur je Days=-1:

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=-1' \
  --data-urlencode 'Hours=0'

Pinnen of ontpinnen

Pint of ontpint de flipbook (de sterstatus) zodat hij bovenaan je dashboard wordt gesorteerd. Dit is een toggle en neemt geen body.

curl -X PUT 'https://go.fliplink.me/api/set-pin/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Response:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Mogelijke fouten

• Ontbrekende of ongeldige API-sleutel → HTTP 401. Dit geeft een kale Unauthorized-HTML-pagina terug — er is geen JSON-body. Controleer of de X-Api-Key-header aanwezig en correct is.
• Onbekende flipbookId (of een die niet bij je sleutel hoort) → HTTP 200 met "Message": "Item not found".
• Voor-/achterpagina instellen (bestand) — ongeldige PDF → HTTP 200 met "Message": "File is not a valid PDF." wanneer het geüploade bestand geen leesbare PDF is.
• Voor-/achterpagina instellen (bestand) — bestand te groot → HTTP 413 met "Message": "File exceeds the maximum allowed upload size." wanneer de upload de maximale bestandsgrootte van het abonnement overschrijdt.
• Voor-/achterpagina instellen (URL) en Verlopen instellen — onbekend veld → HTTP 200 met "Message": "Unknown field(s) '…'. Expected: …" wanneer een body-veld verkeerd gespeld of niet herkend is.