Μέθοδοι Αποστολής

Το Legalesign API παρέχει διάφορους τρόπους για να αποστείλετε έγγραφα προς υπογραφή. Κάθε μέθοδος ταιριάζει σε διαφορετική περίπτωση χρήσης. Όλες οι μέθοδοι είναι ασύγχρονες — επιστρέφουν ένα ID αμέσως και επεξεργάζονται το έγγραφο στο παρασκήνιο.

Γρήγορη Σύγκριση

Μέθοδος	Περίπτωση χρήσης	Έγγραφα	Κλήσεις API
send	Αποστολή ενός εγγράφου σε έναν ή περισσότερους παραλήπτες	1	1
sendBatch	Αποστολή πολλών διαφορετικών εγγράφων ως ομάδα	Πολλά	3+ (create → add docs → start)
sendBulk	Αποστολή του ίδιου προτύπου σε πολλούς διαφορετικούς παραλήπτες	Πολλά	3+ (start → queue docs → send)
createTask	Εκτέλεση ασύγχρονων εργασιών όπως εκθέσεις	Δεν εφαρμόζεται	1

send — Μονό Έγγραφο

Η πιο απλή και συνηθισμένη μέθοδος. Μία κλήση API αποστέλλει ένα έγγραφο σε έναν ή περισσότερους παραλήπτες.

mutation {
  send(input: {
    groupId: "Z3JwMTIzNDU2"
    templateId: "dHBsMTIzNDU2"
    title: "Employment Contract"
    recipients: [
      { firstName: "Jane", lastName: "Smith", email: "jane@example.com", role: "Signer" }
    ]
  })
}

Πότε να χρησιμοποιηθεί: Οι περισσότερες ενσωματώσεις. Αποστολή συμβολαίου, NDA ή οποιουδήποτε μονού εγγράφου. Αν χρειάζεται να στέλνετε έγγραφα ένα-ένα από την εφαρμογή σας, αυτή είναι η κατάλληλη επιλογή.

Επιστρέφει: Ένα αναγνωριστικό εργασίας. Θα κάνετε polling με το ερώτημα task και θα παρακολουθείτε το task.report.status μέχρι να φτάσει σε COMPLETED ή FAILED.

Δείτε: send reference · DocumentSendSettingsInput

sendBatch — Πολλαπλά Έγγραφα ως Ομάδα

Αποστέλλει πολλά διαφορετικά έγγραφα που είναι λογικά συνδεδεμένα (π.χ. πακέτο απασχόλησης με συμβόλαιο, NDA και επιβεβαίωση βιβλιαρίου). Τα έγγραφα ομαδοποιούνται σε ένα Batch και μπορούν να σταλούν με συγκεκριμένη σειρά.

Η ροή εργασίας απαιτεί τρία βήματα:

# Step 1: Create the batch
mutation { sendBatch(input: { groupId: "Z3JwMTIzNDU2", batchName: "New Hire Pack" }) }
# Returns: batchId

# Step 2: Add documents to the batch (repeat for each document)
mutation { sendBatchDocument(input: {
  batchId: "<batchId>",
  sendOrder: 1,
  document: {
    groupId: "Z3JwMTIzNDU2"
    templateId: "dHBsMTIzNDU2"
    title: "Employment Contract"
    recipients: [{ firstName: "Jane", lastName: "Smith", email: "jane@example.com", role: "Signer" }]
  }
}) }

# Step 3: Start the batch
mutation { startBatch(input: { batchId: "<batchId>", groupId: "Z3JwMTIzNDU2" }) }

Πότε να χρησιμοποιηθεί: Αποστολή πολλών σχετικών εγγράφων στο ίδιο πρόσωπο ή ομάδα ανθρώπων. Η σημαία enforceOrder ελέγχει αν τα έγγραφα πρέπει να υπογραφούν κατά σειρά ή μπορούν να υπογραφούν με οποιαδήποτε σειρά.

Δείτε: sendBatch · sendBatchDocument · startBatch · Batch τύπος

sendBulk — Το Ίδιο Πρότυπο σε Πολλούς Παραλήπτες

Αποστέλλει το ίδιο πρότυπο σε πολλούς διαφορετικούς παραλήπτες παράλληλα. Χρήσιμο για μαζικές αποστολές όπως ετήσιες ανανεώσεις πολιτικής ή επιβεβαιώσεις συμμόρφωσης.

Η ροή εργασίας:

# Step 1: Create the bulk task
mutation { startBulk(input: { groupId: "Z3JwMTIzNDU2", name: "Annual Policy Renewal" }) }
# Returns: bulkId

# Step 2: Queue documents (repeat for each recipient)
mutation { addBulkDocument(input: {
  bulkId: "<bulkId>",
  document: {
    groupId: "Z3JwMTIzNDU2"
    templateId: "dHBsMTIzNDU2"
    title: "Policy Renewal - John Doe"
    recipients: [{ firstName: "John", lastName: "Doe", email: "john@example.com", role: "Signer" }]
  }
}) }

# Step 3: Send all queued documents
mutation { sendBulk(input: { groupId: "Z3JwMTIzNDU2", bulkId: "<bulkId>", name: "Annual Policy Renewal" }) }

Πότε να χρησιμοποιηθεί: Αποστολή του ίδιου εγγράφου σε εκατοντάδες ή χιλιάδες διαφορετικά άτομα. Πιο αποδοτικό από το να καλείτε send σε βρόχο, επειδή η πλατφόρμα επεξεργάζεται την ουρά παράλληλα.

Δείτε: startBulk · addBulkDocument · sendBulk

createTask — Ασύγχρονες Εργασίες

Δεν είναι μέθοδος αποστολής, αλλά σχετική. Το createTask ενεργοποιεί ασύγχρονες λειτουργίες όπως τη δημιουργία εκθέσεων. Το σύστημα εργασιών είναι το ίδιο που υποστηρίζει το send — και οι δύο επιστρέφουν ένα αναγνωριστικό εργασίας που μπορείτε να κάνετε polling.

mutation {
  createTask(input: {
    groupId: "Z3JwMTIzNDU2"
    title: "Audit Report"
    status: DRAFT
  }) {
    id
    status
  }
}

Δείτε: createTask · TaskStatus

Επιλογή της Κατάλληλης Μεθόδου

Need to send one document?
  → use send

Need to send multiple different documents as a package?
  → use sendBatch

Need to send the same template to many people?
  → use sendBulk

Just need one or two documents sent from your app?
  → use send (even if you call it multiple times)

Οι περισσότερες ενσωματώσεις χρειάζονται μόνο το send. Χρησιμοποιήστε το sendBatch και το sendBulk όταν έχετε συγκεκριμένη ροή εργασίας που απαιτεί ομαδοποίηση ή μαζική αποστολή.

Επιλογές Ειδοποιήσεων

Τanto το sendBatch όσο και το sendBulk δέχονται σημαίες ειδοποίησης που ελέγχουν τη συμπεριφορά των email:

Σημαία	Περιγραφή
enforceOrder	Τα έγγραφα πρέπει να υπογραφούν με τη συγκεκριμένη sendOrder
notifySender	Στείλτε email στον αποστολέα όταν υπογράφεται κάθε έγγραφο
notifySenderAttach	Προσαρτήστε το υπογεγραμμένο PDF στην ειδοποίηση αποστολέα
notifyParticipants	Στείλτε email στους συμμετέχοντες όταν ολοκληρώνεται το έγγραφο
notifyParticipantsAttach	Προσαρτήστε το υπογεγραμμένο PDF στις ειδοποιήσεις συμμετεχόντων

Η μετάλλαξη send κληρονομεί αυτές τις ρυθμίσεις από τη διαμόρφωση Experience της ομάδας.