Metadati, URL personalizzato e pubblicazione

Cosa puoi fare

Questi quattro endpoint controllano come un flipbook si presenta — il suo titolo e i metadati SEO, il suo stato di pubblicazione, il suo URL di condivisione e l'aspetto dell'esperienza di lettura. Ognuno agisce su un singolo flipbook tramite il suo {flipbookId}:

• Impostare il titolo e i meta SEO — Title, Description, TitleColor e il flag IsPublished.
• Pubblicare o annullare la pubblicazione senza toccare il titolo o la descrizione.
• Assegnargli uno slug personalizzato per l'URL di condivisione.
• Configurare l'aspetto della pagina del viewer — profondità della pagina e tipo di copertina.

Prima di iniziare

• Una chiave API — inviata come header X-Api-Key o come Authorization: Bearer YOUR_API_KEY in ogni richiesta.
• Il {flipbookId} — l'ID numerico del flipbook, restituito da create-by-file / create-by-url (come ID) o da list. Tutti e quattro gli endpoint qui sotto lo usano come parametro nel percorso.
• Tutte le richieste vanno all'URL di base https://go.fliplink.me.
• Ogni body di richiesta qui è form-urlencoded (non JSON) — invia ogni campo con --data-urlencode.

Impostare il titolo e i meta SEO

PUT /api/set-meta/{flipbookId} imposta il titolo e i meta SEO del flipbook — Title, Description, TitleColor e il flag IsPublished. Questo sovrascrive Title/Description/TitleColor. Per cambiare solo lo stato di pubblicazione, usa invece set-published (sotto). TitleColor accetta un colore esadecimale con il # iniziale (per esempio #1a1a1a; predefinito #000000) e viene memorizzato così com'è.

curl -X PUT 'https://go.fliplink.me/api/set-meta/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Title=Spring 2026 Catalog' \
  --data-urlencode 'Description=Our latest product lineup and pricing' \
  --data-urlencode 'IsPublished=true'

Risposta:

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

Pubblicare o annullare la pubblicazione

PUT /api/set-published/{flipbookId} cambia SOLO il flag di pubblicazione, lasciando intatti Title/Description/TitleColor (a differenza di set-meta). Usalo per (ri)pubblicare un flipbook — per esempio, uno tornato non pubblicato da create-by-file. IsPublished è obbligatorio: true/1 = pubblica, false/0 = annulla la pubblicazione.

curl -X PUT 'https://go.fliplink.me/api/set-published/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPublished=true'

Risposta:

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

Impostare un URL personalizzato

PUT /api/set-custom-url/{flipbookId} imposta lo slug personalizzato per l'URL di condivisione del flipbook tramite il campo CustomURL. Lo slug deve essere univoco — uno slug già in uso restituisce Result: "ERROR" (vedi gli errori sotto).

curl -X PUT 'https://go.fliplink.me/api/set-custom-url/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomURL=spring-catalog'

Risposta:

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

Impostare l'aspetto della pagina

PUT /api/set-page-appearance/{flipbookId} configura l'aspetto della pagina del viewer. Questo endpoint attualmente espone solo due campi impostabili: PageDepth (accetta flat, thin o thick) e CoverType (accetta soft o hard). I valori vengono memorizzati alla lettera; gli elementi più vecchi possono riportare altri valori (per esempio regular, o il numerico 1) quando vengono riletti tramite Get one.

curl -X PUT 'https://go.fliplink.me/api/set-page-appearance/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PageDepth=thin' \
  --data-urlencode 'CoverType=soft'

Risposta:

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

Errori possibili

Questi errori valgono per i quattro endpoint (custom-URL ne aggiunge uno suo):

• 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 (o Authorization: Bearer) sia presente e corretto.
• ID dell'elemento non trovato o non di proprietà della tua chiave → HTTP 200 con { "Result": "ERROR", "Message": "Item not found" }.
• URL personalizzato già occupato (solo set-custom-url) → HTTP 200 con { "Result": "ERROR", "Message": "This custom URL is already in use. Please choose another." }.
• Campo del body sconosciuto o scritto male → HTTP 200 con Message: "Unknown field(s) '…'. Expected: …".

Una regola pratica: Result: "OK" significa che la modifica è stata applicata; Result: "ERROR" significa che non lo è stata — leggi il Message per capirne il motivo.

Note

• set-meta vs set-published: set-meta sovrascrive Title/Description/TitleColor, quindi se vuoi cambiare solo lo stato di pubblicazione, usa set-published — lascia intatti quei campi.