Omslag- en voorbeeldafbeeldingen

Wat je kunt doen

Twee schrijf-endpoints regelen de PDF's die een flipbook vervangen voordat een lezer volledige toegang krijgt:

• Stel de voorbeeld-PDF in die aan lezers wordt getoond vóór leadverzameling / betaling.
• Stel de afbeeldings-PDF in die voor thumbnails en previews wordt gebruikt.

Elke aanroep richt zich op één flipbook via zijn {flipbookId} en geeft een eenvoudig succesresultaat terug.

Voordat je begint

Je hebt nodig:

• Een API-sleutel — meegestuurd als de X-Api-Key-header, of als Authorization: Bearer YOUR_API_KEY, op elk verzoek.
• De {flipbookId} — de numerieke ID van de flipbook/het document, teruggegeven door create-by-file / create-by-url (als ID) of door list.
• Alle verzoeken gaan naar de basis-URL https://go.fliplink.me.

Beide endpoints nemen een form-urlencoded body (geen JSON).

De voorbeeld-PDF instellen

PUT /api/set-preview-pdf/{flipbookId} stelt de voorbeeld-PDF in die aan lezers wordt getoond vóór leadverzameling / betaling. Die wordt automatisch gewist als zowel leadverzameling als verkoopmodus uit staan.

Stuur de URL van de te gebruiken PDF mee als PreviewPDF:

• PreviewPDF — de URL van de PDF die als voorbeeld moet worden getoond. De waarde wordt opgeslagen zoals hij is; de API controleert niet of de URL bereikbaar is (live-getest), dus stuur een geldige, bereikbare PDF-URL. De standaard is leeg (geen voorbeeld-PDF).

curl -X PUT 'https://go.fliplink.me/api/set-preview-pdf/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PreviewPDF=https://go.fliplink.me/files/preview.pdf'

Response:

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

De afbeeldings-PDF instellen

PUT /api/set-image-pdf/{flipbookId} stelt de PDF met alleen afbeeldingen/voorbeeld in die voor thumbnails en previews wordt gebruikt. Stuur de URL van de te gebruiken PDF mee als IMGPdf:

• IMGPdf — de URL van de PDF met alleen afbeeldingen die voor thumbnails en previews moet worden gebruikt. De waarde wordt opgeslagen zoals hij is; de API controleert niet of de URL bereikbaar is (live-getest), dus stuur een geldige, bereikbare PDF-URL. De standaard is een no-image-placeholder, en het meesturen van een lege waarde behoudt de bestaande afbeeldings-PDF.

curl -X PUT 'https://go.fliplink.me/api/set-image-pdf/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IMGPdf=https://go.fliplink.me/files/pages.pdf'

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 (of Authorization: Bearer) aanwezig en correct is.
• Item-ID niet gevonden of niet in eigendom van je sleutel → HTTP 200 met Message Item not found.
• Onbekend of verkeerd gespeld body-veld → HTTP 200 met Message Unknown field(s) '…'. Expected: ….

Opmerkingen

• Voor beide velden wordt de URL-waarde opgeslagen zoals hij is — de API controleert niet of de PDF bereikbaar is (live-getest). Stuur altijd een geldige, bereikbare PDF-URL.
• De voorbeeld-PDF (PreviewPDF) is standaard leeg en wordt automatisch gewist als zowel leadverzameling als verkoopmodus uit staan.
• De afbeeldings-PDF (IMGPdf) is standaard een no-image-placeholder; het meesturen van een lege waarde behoudt de bestaande afbeeldings-PDF.