Le workflow de validation

Ce que tu peux faire

Le workflow de validation de FlipLink permet aux lecteurs de demander la validation d'un document. Deux endpoints le configurent :

• Ajouter un bouton de demande de validation au lecteur. L'activer déclenche le workflow de demande de validation.
• Définir les modèles d'e-mail utilisés par le workflow de validation — les e-mails de demande, de rappel et de soumission.

Le workflow de validation s'applique uniquement aux éléments de type Document — les éléments créés avec DocType=document. Il n'est pas disponible sur les flipbooks standard.

Avant de commencer

Tu auras besoin de :

• Une clé d'API — envoyée dans l'en-tête X-Api-Key, ou via Authorization: Bearer YOUR_API_KEY, à chaque requête.
• Le {flipbookId} — l'ID numérique du document que tu configures. Il est renvoyé par create-by-file / create-by-url (sous la forme ID) ou par list.
• Toutes les requêtes sont envoyées à l'URL de base https://go.fliplink.me.

Les deux endpoints prennent un corps au format form-urlencoded (pas JSON).

Ajouter le bouton de validation

PUT /api/set-approval-button/{flipbookId} ajoute un bouton de demande de validation au lecteur. L'activer déclenche le workflow de demande de validation.

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'

Champs :

• IsApprovalButton — true pour afficher le bouton de demande de validation, false pour le masquer.
• ApprovalButtonText — le libellé du bouton.
• ApprovalButtonColor — la couleur de fond du bouton, sous forme de valeur hexadécimale avec le # en tête (par exemple #0055FF). Par défaut #000000. La valeur est stockée telle quelle ; l'API ne la valide pas.
• ApprovalButtonTextColor — la couleur du texte du bouton, sous forme de valeur hexadécimale avec le # en tête (par exemple #FFFFFF). Par défaut #FFFFFF. La valeur est stockée telle quelle ; l'API ne la valide pas.

Réponse :

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

Définir les modèles d'e-mail de validation

PUT /api/set-approval-email-templates/{flipbookId} définit les modèles d'e-mail utilisés par le workflow de validation. Chaque champ possède un texte par défaut intégré ; laisser un champ vide conserve ce texte par défaut.

Le texte des modèles peut inclure des tokens de fusion au format ##TOKEN##, qui sont remplacés à l'envoi de l'e-mail — par exemple, ##DOCUMENT_TITLE## insère le titre du document.

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='

Réponse :

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

Erreurs possibles

• Clé d'API manquante ou invalide → HTTP 401. Renvoie une simple page HTML « Unauthorized » — il n'y a pas de corps JSON. Vérifie que l'en-tête X-Api-Key est présent et correct.
• ID d'élément introuvable ou non associé à ta clé → HTTP 200 avec Message: "Item not found".
• Champ de corps inconnu ou mal orthographié → HTTP 200 avec Message: "Unknown field(s) '…'. Expected: …".

Notes

• Sur l'endpoint des modèles d'e-mail, chaque champ possède un texte par défaut intégré ; envoyer une valeur vide pour un champ conserve le texte par défaut de ce modèle.
• Le texte des modèles d'e-mail prend en charge les tokens de fusion ##TOKEN## (par exemple ##DOCUMENT_TITLE## pour le titre du document), substitués au moment de l'envoi.
• Les couleurs du bouton (ApprovalButtonColor, ApprovalButtonTextColor) sont des valeurs hexadécimales avec un # en tête et sont stockées telles quelles sans validation ; les valeurs par défaut sont #000000 et #FFFFFF.