Metadata, eigen URL en publiceren

Wat je kunt doen

Deze vier endpoints bepalen hoe een flipbook zich presenteert — de titel en SEO-metadata, de publicatiestatus, de deel-URL en het uiterlijk van de leeservaring. Elk endpoint richt zich op één flipbook via zijn {flipbookId}:

• Stel de titel en SEO-metadata in — Title, Description, TitleColor en de IsPublished-vlag.
• Publiceer of depubliceer zonder de titel of beschrijving aan te raken.
• Geef hem een eigen (vanity-)slug voor de deel-URL.
• Configureer de pagina-weergave van de viewer — paginadiepte en omslagtype.

Voordat je begint

• Een API-sleutel — meegestuurd op elk verzoek als de X-Api-Key-header of als Authorization: Bearer YOUR_API_KEY.
• De {flipbookId} — de numerieke ID van de flipbook, teruggegeven door create-by-file / create-by-url (als ID) of door list. Alle vier de endpoints hieronder gebruiken hem als padparameter.
• Alle verzoeken gaan naar de basis-URL https://go.fliplink.me.
• Elke request-body hier is form-urlencoded (geen JSON) — stuur elk veld met --data-urlencode.

De titel en SEO-metadata instellen

PUT /api/set-meta/{flipbookId} stelt de titel en SEO-metadata van de flipbook in — Title, Description, TitleColor en de IsPublished-vlag. Dit overschrijft Title/Description/TitleColor. Wil je alleen de publicatiestatus wijzigen, gebruik dan set-published (hieronder). TitleColor neemt een hex-kleur met het voorafgaande # (bijv. #1a1a1a; standaard #000000) en wordt opgeslagen zoals hij is.

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'

Response:

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

Publiceren of depubliceren

PUT /api/set-published/{flipbookId} schakelt ALLEEN de publicatievlag om en laat Title/Description/TitleColor intact (anders dan set-meta). Gebruik het om een flipbook te (her)publiceren — bijvoorbeeld een die ongepubliceerd terugkwam uit create-by-file. IsPublished is verplicht: true/1 = publiceren, false/0 = depubliceren.

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

Response:

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

Een eigen URL instellen

PUT /api/set-custom-url/{flipbookId} stelt de eigen (vanity-)slug voor de deel-URL van de flipbook in via het veld CustomURL. De slug moet uniek zijn — een slug die al in gebruik is, geeft Result: "ERROR" terug (zie de fouten hieronder).

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

Response:

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

De pagina-weergave instellen

PUT /api/set-page-appearance/{flipbookId} configureert de pagina-weergave van de viewer. Dit endpoint biedt momenteel maar twee instelbare velden: PageDepth (accepteert flat, thin of thick) en CoverType (accepteert soft of hard). Waarden worden letterlijk opgeslagen; oudere items kunnen andere waarden teruggeven (bijv. regular, of numeriek 1) wanneer je ze teruglezt via Eén ophalen.

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'

Response:

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

Mogelijke fouten

Deze fouten gelden voor alle vier de endpoints (custom-URL voegt er een eigen fout aan toe):

• 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- (of Authorization: Bearer-)header aanwezig en correct is.
• Item-ID niet gevonden of niet in eigendom van je sleutel → HTTP 200 met { "Result": "ERROR", "Message": "Item not found" }.
• Eigen URL al bezet (alleen set-custom-url) → HTTP 200 met { "Result": "ERROR", "Message": "This custom URL is already in use. Please choose another." }.
• Onbekend of verkeerd gespeld body-veld → HTTP 200 met Message: "Unknown field(s) '…'. Expected: …".

Een handige vuistregel: Result: "OK" betekent dat de wijziging is doorgevoerd; Result: "ERROR" betekent van niet — lees het Message-veld voor de reden.

Opmerkingen

• set-meta versus set-published: set-meta overschrijft Title/Description/TitleColor, dus als je alleen de publicatiestatus wilt wijzigen, gebruik dan set-published — dat laat die velden intact.