Een eigen domein instellen (CNAME)

Wat je kunt doen

Met een eigen domein (CNAME) kan een flipbook worden geserveerd vanaf een hostnaam die jij bezit, zoals docs.example.com. Zodra een domein is toegevoegd en geverifieerd in het webdashboard, kun je met deze drie endpoints de koppeling tussen dat domein en je flipbooks via de API beheren:

• Voeg een CNAME-koppeling toe aan een flipbook.
• Bekijk elke CNAME op je account, met de flipbooks waaraan elke is gekoppeld.
• Verwijder een CNAME-koppeling van één flipbook of van alle tegelijk.

Voordat je begint

• Een API-sleutel — meegestuurd als de X-Api-Key-header (of als Authorization: Bearer YOUR_API_KEY) op elk verzoek.
• Alle verzoeken gaan naar de basis-URL https://go.fliplink.me.
• Add CNAME richt zich op een specifieke flipbook via het {flipbookId}-padsegment — de numerieke ID die wordt teruggegeven door create-by-file / create-by-url of door list. List en Delete gebruiken geen {flipbookId}-padparameter.
• De CNAME moet al bestaan en geactiveerd zijn op je account — toegevoegd en geverifieerd via het webdashboard, dat de DNS en SSL regelt. De API slaat alleen de koppeling op; hij verifieert geen DNS en geeft geen certificaten uit.
• Voor Add CNAME is de request-body form-urlencoded (geen JSON).

Een CNAME aan een flipbook toevoegen

Koppelt een al geactiveerd eigen domein aan een flipbook. Geef de volledige hostnaam mee als CNAME. IsCloudflare is optioneel en standaard 0; geef 1 mee als je DNS achter de proxy van Cloudflare zit.

curl -X POST 'https://go.fliplink.me/api/add-cname/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CNAME=docs.example.com' \
  --data-urlencode 'IsCloudflare=0'

Response:

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

Als het domein niet eerst op je account is geactiveerd, wordt het verzoek geweigerd met: Please add CNAME <domain> to your account using the web dashboard. Only activated CNAMEs are allowed to be created via API.

Je CNAMEs bekijken

Geeft alle eigen CNAMEs voor de aanroeper terug. Elk item vermeldt de hostnaam, het aantal actieve flipbooks dat eraan gekoppeld is (Documents) en de lijst van die actieve flipbook-ID's (FlipbookIDs).

curl -X GET 'https://go.fliplink.me/api/list-cnames' \
  -H 'X-Api-Key: YOUR_API_KEY'

Response:

{
  "Result": "OK",
  "Items": [
    {
      "CNAME": "ttr.antifragile.ae",
      "Documents": 1,
      "FlipbookIDs": [
        93270
      ]
    }
  ]
}

Een CNAME-koppeling verwijderen

Verwijdert de koppeling van een eigen domein van een of al je flipbooks. Er zijn twee modi:

• Bulk (standaard): geef CNAME=<host> mee en laat FlipbookID leeg — verwijdert die CNAME van elke flipbook die je bezit.
• Per flipbook: geef FlipbookID=<id> (groter dan 0) mee — de CNAME wordt opgezocht bij die flipbook en alleen van die ene verwijderd.

Geef de CNAME mee als queryparameter (geen URL-segment) om problemen met de punten in de hostnaam te voorkomen.

curl -X DELETE 'https://go.fliplink.me/api/delete-cname?CNAME=docs.example.com&FlipbookID=' \
  -H 'X-Api-Key: YOUR_API_KEY'

De curl hierboven draait in bulk-modus (FlipbookID leeg gelaten), dus de response is:

{
  "Result": "OK",
  "Message": "CNAME removed successfully"
}

In de per-flipbook-modus (FlipbookID groter dan 0) is het bericht in plaats daarvan { "Result": "OK", "Message": "CNAME removed from flipbook successfully" }. Als je noch CNAME noch FlipbookID meegeeft, is de response { "Result": "ERROR", "Message": "CNAME or FlipbookID is required" }.

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), bij Add CNAME → HTTP 200 met { "Result": "ERROR", "Message": "Item not found" }.
• Onbekend of verkeerd gespeld body-veld, bij Add CNAME → HTTP 200 met { "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }.
• Verwijderen zonder CNAME en zonder FlipbookID → { "Result": "ERROR", "Message": "CNAME or FlipbookID is required" }.

Opmerkingen

• Een CNAME via de API toevoegen slaat alleen de koppeling op — het verifieert geen DNS en geeft geen certificaten uit. Voeg het domein eerst toe en verifieer het in het webdashboard.
• De CNAME moet binnen de CNAME-limiet van je abonnement vallen.