Der Freigabe-Workflow

Was du tun kannst

Der Freigabe-Workflow von FlipLink erlaubt es Betrachtern, eine Freigabe für ein Dokument anzufordern. Zwei Endpunkte konfigurieren ihn:

• Einen Freigabe-Anfrage-Button zum Viewer hinzufügen. Wenn du ihn aktivierst, löst das den Freigabe-Anfrage-Workflow aus.
• Die E-Mail-Vorlagen festlegen, die der Freigabe-Workflow verwendet – die Anfrage-, Erinnerungs- und Absende-E-Mails.

Der Freigabe-Workflow gilt nur für Document-Items – Items, die mit DocType=document erstellt wurden. Bei Standard-Flipbooks ist er nicht verfügbar.

Bevor du loslegst

Du brauchst:

• Einen API-Schlüssel – wird bei jeder Anfrage als X-Api-Key-Header oder als Authorization: Bearer YOUR_API_KEY gesendet.
• Die {flipbookId} – die numerische ID des Dokuments, das du konfigurierst. Sie wird von create-by-file / create-by-url (als ID) oder von list zurückgegeben.
• Alle Anfragen gehen an die Basis-URL https://go.fliplink.me.

Beide Endpunkte nehmen einen form-urlencoded Body entgegen (kein JSON).

Den Freigabe-Button hinzufügen

PUT /api/set-approval-button/{flipbookId} fügt dem Viewer einen Freigabe-Anfrage-Button hinzu. Wenn du ihn aktivierst, löst das den Freigabe-Anfrage-Workflow aus.

curl -X PUT 'https://go.fliplink.me/api/set-approval-button/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsApprovalButton=true' \
  --data-urlencode 'ApprovalButtonText=Request approval' \
  --data-urlencode 'ApprovalButtonColor=#0055FF' \
  --data-urlencode 'ApprovalButtonTextColor=#FFFFFF'

Felder:

• IsApprovalButton – true, um den Freigabe-Anfrage-Button anzuzeigen, false, um ihn auszublenden.
• ApprovalButtonText – die Button-Beschriftung.
• ApprovalButtonColor – die Hintergrundfarbe des Buttons als Hex-Wert mit führendem # (z. B. #0055FF). Standard ist #000000. Der Wert wird unverändert gespeichert; die API validiert ihn nicht.
• ApprovalButtonTextColor – die Textfarbe des Buttons als Hex-Wert mit führendem # (z. B. #FFFFFF). Standard ist #FFFFFF. Der Wert wird unverändert gespeichert; die API validiert ihn nicht.

Antwort:

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

Die Freigabe-E-Mail-Vorlagen festlegen

PUT /api/set-approval-email-templates/{flipbookId} legt die E-Mail-Vorlagen fest, die der Freigabe-Workflow verwendet. Jedes Feld hat einen eingebauten Standardtext; lässt du ein Feld leer, bleibt dieser Standard erhalten.

Der Vorlagentext kann Merge-Tokens in der Form ##TOKEN## enthalten, die beim Versand der E-Mail ersetzt werden – zum Beispiel fügt ##DOCUMENT_TITLE## den Titel des Dokuments ein.

curl -X PUT 'https://go.fliplink.me/api/set-approval-email-templates/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailApproveRequestSubject=Approval needed: ##DOCUMENT_TITLE##' \
  --data-urlencode 'EmailApproveRequestBody=' \
  --data-urlencode 'EmailApproveRemindSubject=' \
  --data-urlencode 'EmailApproveRemindBody=' \
  --data-urlencode 'EmailApproveSubmitSubject=' \
  --data-urlencode 'EmailApproveSubmitBody='

Antwort:

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

Mögliche Fehler

• Fehlender oder ungültiger API-Schlüssel → HTTP 401. Das gibt eine reine Unauthorized-HTML-Seite zurück – es gibt keinen JSON-Body. Prüfe, ob der X-Api-Key-Header vorhanden und korrekt ist.
• Item-ID nicht gefunden oder nicht im Besitz deines Schlüssels → HTTP 200 mit Message: "Item not found".
• Unbekanntes oder falsch geschriebenes Body-Feld → HTTP 200 mit Message: "Unknown field(s) '…'. Expected: …".

Hinweise

• Beim E-Mail-Vorlagen-Endpunkt hat jedes Feld einen eingebauten Standardtext; sendest du für ein Feld einen leeren Wert, bleibt der Standard dieser Vorlage erhalten.
• Der E-Mail-Vorlagentext unterstützt ##TOKEN##-Merge-Tokens (z. B. ##DOCUMENT_TITLE## für den Titel des Dokuments), die beim Versand ersetzt werden.
• Button-Farben (ApprovalButtonColor, ApprovalButtonTextColor) sind Hex-Werte mit führendem # und werden unverändert ohne Validierung gespeichert; die Standardwerte sind #000000 und #FFFFFF.