Σημείωση εγγράφου ως υπογεγραμμένου
Σημειώστε ένα έγγραφο ως υπογεγραμμένο όταν έχει ληφθεί φυσική ή εξωτερική υπογραφή. Μπορείτε να σημειώσετε ολόκληρο το έγγραφο ως ολοκληρωμένο ή να σημειώσετε έναν μεμονωμένο παραλήπτη ως ολοκληρωμένο αν άλλοι υπογράφουν ακόμα. Μπορείτε να ανεβάσετε ένα υπογεγραμμένο PDF ταυτόχρονα.
Προαπαιτούμενα
- Το αναγνωριστικό εγγράφου σας (κωδικοποιημένο σε base64) — αν έχετε ένα UUID REST, προσθέστε στην αρχή το
docκαι κωδικοποιήστε το αποτέλεσμα σε base64 (π.χ.doc+<your-document-uuid>→ base64). Δείτε Κατανόηση Web IDs και API IDs για λεπτομέρειες.
Επιλογή Α: Σημειώστε ως υπογεγραμμένο χωρίς ανέβασμα PDF
Κάντε κλήση στο markAsComplete με isUploaded: false. Το πεδίο declarationText είναι υποχρεωτικό — χρησιμοποιήστε το για να καταγράψετε τον λόγο για τον οποίο το έγγραφο σημειώνεται ως ολοκληρωμένο (π.χ. "Λήφθηκε προφορική επιβεβαίωση", "Λήφθηκε φυσική υπογραφή"). Μπορεί να μείνει κενή συμβολοσειρά, αλλά μια ουσιαστική τιμή είναι χρήσιμη για σκοπούς ελέγχου.
mutation MarkAsComplete {
markAsComplete(input: {
documentId: "<document-id>"
declarationText: "Verbal confirmation received"
isUploaded: false
})
}
Επιλογή Β: Σημειώστε ως υπογεγραμμένο με ανέβασμα PDF
Βήμα 1: Λήψη προεγγεγραμμένου URL ανέβασματος
Κάντε κλήση στο upload ερώτημα με uploadType: MARKASCOMPLETE για να λάβετε ένα βραχύβιο URL S3.
query GetUploadUrl {
upload(
id: "<document-id>"
uploadType: MARKASCOMPLETE
extension: "pdf"
) {
url
}
}
Απάντηση:
{
"data": {
"upload": {
"url": "https://lon-files-clearing.s3-accelerate.amazonaws.com/upload/..."
}
}
}
Βήμα 2: Πραγματοποιήστε PUT του αρχείου στο S3
Ανεβάστε το υπογεγραμμένο PDF απευθείας στο URL που επιστράφηκε χρησιμοποιώντας αίτημα HTTP PUT με Content-Type: application/pdf. Το URL είναι βραχύβιο — χρησιμοποιήστε το αμέσως. Δείτε Ανέβασμα αρχείων για περισσότερες λεπτομέρειες σχετικά με το βήμα PUT.
curl -X PUT \
-H "Content-Type: application/pdf" \
--data-binary @signed-copy.pdf \
"<url from previous step>"
Βήμα 3: Σημειώστε το έγγραφο ως ολοκληρωμένο
Κάντε κλήση στο markAsComplete με isUploaded: true. Το πεδίο declarationText λειτουργεί όπως στην Επιλογή Α.
mutation MarkAsComplete {
markAsComplete(input: {
documentId: "<document-id>"
declarationText: "Signed copy received by post"
isUploaded: true
})
}
Σημειώστε έναν μεμονωμένο παραλήπτη ως υπογεγραμμένο
Χρησιμοποιήστε το markRecipientAsComplete όταν ένα μέρος έχει υπογράψει εξωτερικά αλλά άλλοι όχι.
Αν θέλετε να ανεβάσετε έναν υπογεγραμμένο PDF για τον παραλήπτη, πρώτα λάβετε ένα προεγγεγραμμένο URL χρησιμοποιώντας uploadType: MARKRECIPIENTASCOMPLETE:
query GetUploadUrl {
upload(
id: "<recipient-id>"
uploadType: MARKRECIPIENTASCOMPLETE
extension: "pdf"
) {
url
}
}
Έπειτα κάντε PUT το αρχείο στο URL που επιστράφηκε — δείτε Ανέβασμα αρχείων.
Βασικά πεδία:
suppressNextRecipientNotification— ορίστε το σεtrueγια να αποτρέψετε την άμεση ειδοποίηση του επόμενου παραλήπτη στη σειρά υπογραφής.auditlogText— προαιρετικό. Αφήστε το κενό αν δεν χρειάζεται, αλλά μια ουσιαστική τιμή είναι χρήσιμη για σκοπούς ελέγχου.
Έπειτα καλέστε το markRecipientAsComplete:
mutation MarkRecipientAsComplete {
markRecipientAsComplete(input: {
recipientId: "<recipient-id>"
documentOptions: NONE
suppressNextRecipientNotification: false
auditlogText: "Signed copy received by post"
}) {
id
uploadId
}
}
Αρχειοθέτηση του εγγράφου (προαιρετικά)
Μόλις σημειωθεί ως ολοκληρωμένο, μπορείτε να αρχειοθετήσετε το έγγραφο για να το αφαιρέσετε από την προβολή ενεργών εγγράφων.
mutation ArchiveDocument {
archiveDocument(input: {
documentId: "<document-id>"
restore: false
})
}
Ορίστε το restore: true για να επαναφέρετε την αρχειοθέτηση.