Modhanna Seolta

Soláthraíonn API Legalesign roinnt bealaí chun doiciméid a sheoladh le haghaidh sínithe. Oireann gach modh do úsáid shonrach. Tá gach modh neamhshioncronach — filltear ID láithreach agus próiseálann sé an doiciméad sa chúlra.

Comparáid Thapa

Modh	Úsáid	Doiciméid	Glaonna API
send	Doiciméad amháin a sheoladh chuig duine amháin nó níos mó faighteoirí	1	1
sendBatch	Ilchodanna éagsúla a sheoladh mar ghrúpa	Iolra	3+ (cruthú → doiciméid a chur leis → tosú)
sendBulk	An teimpléad céanna a sheoladh chuig iolraí faighteoirí éagsúla	Iolra	3+ (tosú → doiciméid a chur ar an gcéad)
createTask	Tascanna asíneacha mar thuairiscí a rith	N/A	1

send — Doiciméad Singil

Is é an modh is simplí agus is coitianta. Seolann glao API amháin doiciméad amháin chuig duine amháin nó níos mó faighteoirí.

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

Cathain le húsáid: An chuid is mó de na comhtháthuithe. Ag seoladh conartha, NDA, nó aon doiciméad singil. Má theastaíonn uait doiciméid a sheoladh ceann amháin ag an am ó d’iarratas, is é seo an rogha ceart.

Filltear: ID tasc. Déan polláil leis an gceist task agus monatóireacht ar task.report.status go dtí go sroicheann sé COMPLETED nó FAILED.

Féach: tagairt send · DocumentSendSettingsInput

sendBatch — Ilchodanna mar Ghrúpa

Seolann sé ilchodanna éagsúla atá nasctha go loighciúil (m.sh. pacáiste fostaíochta le conradh, NDA, agus admháil láimhseála). Tá na doiciméid grúpaáilte i Batch agus is féidir iad a sheoladh i ndánlár sonrach.

Éilíonn an sreabhadh oibre trí chéim:

# 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" }) }

Cathain le húsáid: Ag seoladh ilchodanna gaolmhara chuig an duine nó grúpa daoine céanna. Rialaíonn an bratach enforceOrder an bhfuil gá doiciméid a shíniú in ord leanúnach nó an féidir iad a shíniú in aon ord.

Féach: sendBatch · sendBatchDocument · startBatch · cineál Batch

sendBulk — An Teimpléad Céanna chuig Iolraí Faighteoirí

Seolann an teimpléad céanna chuig iolraí faighteoirí éagsúla i gcéanna. Úsáideach do sheolta ar mais cosúil le nuashonruithe bheartais bliantúla nó admhálacha comhlíonta.

An sreabhadh oibre:

# 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" }) }

Cathain le húsáid: Ag seoladh an doiciméid chéanna chuig na céadta nó na mílte daoine éagsúla. Níos éifeachtaí ná glaoch ar send i lúb toisc go próiseálann an t-ardán an cúl i gcéanna.

Féach: startBulk · addBulkDocument · sendBulk

createTask — Tascanna Asíneacha

Ní modh seolta é, ach gaolmhar. Spreagann createTask oibríochtaí neamhshioncronacha cosúil le tuarascálacha a ghiniúint. Tá an córas tascanna mar an gcéanna le send — filltear ID tasc ar an mbeirt agus is féidir leat polláil a dhéanamh orthu.

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

Féach: createTask · TaskStatus

Ag Roghnú an Mhódh Ceart

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)

Ní theastaíonn ach send ó chuid is mó comhtháthuithe amháin. Úsáid sendBatch agus sendBulk nuair atá sreabhadh oibre aonair agat a éilíonn grúpáil nó seoladh mais.

Roghanna Fógraíochta

Glacann sendBatch agus sendBulk le bratacha fógraíochta a rialaíonn iompar ríomhphoist:

Bratach	Cur síos
enforceOrder	Caithfear doiciméid a shíniú in sendOrder sonraithe
notifySender	Ríomhphost a sheoladh chuig an seoltóir nuair a shínítear gach doiciméad
notifySenderAttach	Ceangail an PDF sínithe leis an bhfógra don tseoltóir
notifyParticipants	Ríomhphost a sheoladh chuig rannpháirtithe nuair atá an doiciméad críochnaithe
notifyParticipantsAttach	Ceangail an PDF sínithe le fógraí do rannpháirtithe

Glacann an casadh send na socruithe seo ó chumrú an ghrúpa Experience.