Pagine di copertina, scadenza del link e fissaggio

Cosa puoi fare

Questi cinque endpoint ti permettono di gestire le pagine di copertina di un flipbook, la scadenza del suo link e se è fissato — senza toccare la dashboard:

• Collegare le pagine di copertina anteriore e/o posteriore da un file PDF caricato.
• Collegare le pagine di copertina anteriore e/o posteriore da un URL PDF remoto.
• Rimuovere l'involucro anteriore/posteriore, riportando il flipbook al suo PDF di base senza involucro.
• Impostare o rimuovere una scadenza automatica sul flipbook.
• Fissare o sfissare il flipbook così viene ordinato in cima alla tua dashboard.

Prima di iniziare

• Una chiave API — inviata come header X-Api-Key, o come Authorization: Bearer YOUR_API_KEY, in ogni richiesta.
• Ogni endpoint qui accetta il parametro {flipbookId} nel percorso — l'ID numerico del flipbook, restituito da create-by-file / create-by-url (come ID) o da list. Gli esempi qui sotto usano 96216.
• Tutte le richieste vanno all'URL di base https://go.fliplink.me.
• Gli endpoint della pagina di copertina da URL e di set-expiry inviano un body form-urlencoded (non JSON). L'endpoint della pagina di copertina da file invia multipart form-data (upload di file). Gli endpoint clear e pin non accettano alcun body.

Impostare le pagine di copertina anteriore/posteriore da un file

Collega le pagine di copertina e/o posteriore da file PDF caricati. Front/Back sono entrambi facoltativi — ne serve almeno uno. Le pagine vengono riunite con il PDF principale esistente.

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'

Risposta:

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

Impostare le pagine di copertina anteriore/posteriore da un URL

La variante URL di quanto sopra — collega le pagine di copertina/posteriore da un URL PDF remoto invece che da un file caricato. I campi Front e Back vengono inviati form-urlencoded.

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'

Risposta:

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

Rimuovere le pagine di copertina anteriore/posteriore

Rimuove l'involucro anteriore/posteriore, riportando FilePDF al PDF di base senza involucro (MiddlePDF). È idempotente — un flipbook senza involucro restituisce OK e non cambia nulla. La risposta include l'URL S3 del PDF di base ripristinato. I vecchi oggetti S3 uniti/anteriore/posteriore non vengono eliminati. Non accetta alcun body.

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

Risposta:

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

Impostare o rimuovere la scadenza

Imposta o rimuove la scadenza automatica di un flipbook. Invia Days e Hours come interi. Hours è facoltativo e predefinito a 0. Inviare Days=-1, Hours=0 rimuove completamente la scadenza.

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'

Risposta:

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

Per rimuovere la scadenza, invia 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'

Fissare o sfissare

Fissa o sfissa il flipbook (lo stato con la stella) così viene ordinato in cima alla tua dashboard. È un toggle e non accetta alcun body.

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

Risposta:

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

Errori possibili

• Chiave API mancante o non valida → HTTP 401. Restituisce una semplice pagina HTML di Unauthorized — non c'è alcun body JSON. Controlla che l'header X-Api-Key sia presente e corretto.
• flipbookId sconosciuto (o non di proprietà della tua chiave) → HTTP 200 con "Message": "Item not found".
• Set front/back page (file) — PDF non valido → HTTP 200 con "Message": "File is not a valid PDF." quando il file caricato non è un PDF leggibile.
• Set front/back page (file) — file troppo grande → HTTP 413 con "Message": "File exceeds the maximum allowed upload size." quando l'upload supera la dimensione massima del file del piano.
• Set front/back page (URL) e Set expiry — campo sconosciuto → HTTP 200 con "Message": "Unknown field(s) '…'. Expected: …" quando un campo del body è scritto male o non riconosciuto.