Il flusso di approvazione

Cosa puoi fare

Il flusso di approvazione di FlipLink permette ai lettori di richiedere l'approvazione di un documento. Due endpoint lo configurano:

• Aggiungere un pulsante di richiesta approvazione al viewer. Attivarlo avvia il flusso di richiesta di approvazione.
• Impostare i modelli email usati dal flusso di approvazione — le email di richiesta, promemoria e invio.

Il flusso di approvazione si applica solo agli elementi Document — quelli creati con DocType=document. Non è disponibile sui flipbook standard.

Prima di iniziare

Ti serviranno:

• 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 documento che stai configurando. Viene restituito da create-by-file / create-by-url (come ID) o da list.
• Tutte le richieste vanno all'URL di base https://go.fliplink.me.

Entrambi gli endpoint accettano un body form-urlencoded (non JSON).

Aggiungere il pulsante di approvazione

PUT /api/set-approval-button/{flipbookId} aggiunge un pulsante di richiesta approvazione al viewer. Attivarlo avvia il flusso di richiesta di approvazione.

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'

Campi:

• IsApprovalButton — true per mostrare il pulsante di richiesta approvazione, false per nasconderlo.
• ApprovalButtonText — l'etichetta del pulsante.
• ApprovalButtonColor — il colore di sfondo del pulsante, come valore esadecimale con il # iniziale (per esempio #0055FF). Predefinito #000000. Il valore viene memorizzato così com'è; l'API non lo convalida.
• ApprovalButtonTextColor — il colore del testo del pulsante, come valore esadecimale con il # iniziale (per esempio #FFFFFF). Predefinito #FFFFFF. Il valore viene memorizzato così com'è; l'API non lo convalida.

Risposta:

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

Impostare i modelli email di approvazione

PUT /api/set-approval-email-templates/{flipbookId} imposta i modelli email usati dal flusso di approvazione. Ogni campo ha un testo predefinito integrato; lasciare un campo vuoto mantiene quel valore predefinito.

Il testo del modello può includere merge token nella forma ##TOKEN##, che vengono sostituiti al momento dell'invio dell'email — per esempio, ##DOCUMENT_TITLE## inserisce il titolo del documento.

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

Risposta:

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

Errori possibili

• 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 sia presente e corretto.
• ID dell'elemento non trovato o non di proprietà della tua chiave → HTTP 200 con Message: "Item not found".
• Campo del body sconosciuto o scritto male → HTTP 200 con Message: "Unknown field(s) '…'. Expected: …".

Note

• Nell'endpoint dei modelli email, ogni campo ha un testo predefinito integrato; inviare un valore vuoto per un campo mantiene il valore predefinito di quel modello.
• Il testo dei modelli email supporta i merge token ##TOKEN## (per esempio ##DOCUMENT_TITLE## per il titolo del documento), sostituiti al momento dell'invio.
• I colori dei pulsanti (ApprovalButtonColor, ApprovalButtonTextColor) sono valori esadecimali con un # iniziale e vengono memorizzati così come sono senza convalida; i valori predefiniti sono #000000 e #FFFFFF.