Dòighean Cuiridh

Tha API Legalesign a’ toirt seachad grunn dhòighean air sgrìobhainnean a chuir airson ainmeachadh. Tha gach dòigh freagarrach airson cùis cleachdaidh eadar-dhealaichte. Tha a h-uile dòigh asyncronach — bidh iad a’ toirt air ais ID an-diugh agus a’ giullachd an sgrìobhainn sa bheul-aithris.

Dà-chànan Luath

Dòigh	Cùis cleachdaidh	Sgrìobhainnean	Gairmean API
send	Cuir aon sgrìobhainn gu aon no barrachd luchd-fhaighinn	1	1
sendBatch	Cuir grunn sgrìobhainnean eadar-dhealaichte mar buidheann	Mòran	3+ (cruthachadh → cuir sgrìobhainnean → tòiseachadh)
sendBulk	Cuir an aon shampall gu mòran luchd-fhaighinn eadar-dhealaichte	Mòran	3+ (tòiseachadh → cuir sgrìobhainnean san liosta → cuir)
createTask	Ruith gnìomhan asyncronach mar aithisgean	N/A	1

send — Sgrìobhainn Singilte

An dòigh as sìmplidh agus as cumanta. Bidh aon ghairm API a’ cur aon sgrìobhainn gu aon no barrachd luchd-fhaighinn.

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

Cuin a chleachdas tu: A’ mhòr-chuid de dh’ amalachadh. A’ cur cùmhnant, NDA, no sgrìobhainn singilte sam bith. Ma tha feum agad sgrìobhainnean a chur aon aig an àm bhon tagradh agad, is e seo an roghainn cheart.

Tilleadh: ID gnìomha. Dèan suidheachadh leis an ceist task agus dèan sùil air task.report.status gus am bi e COMPLETED no FAILED.

Faic: send iomradh · DocumentSendSettingsInput

sendBatch — grunn Sgrìobhainnean mar Buidheann

A’ cur grunn sgrìobhainnean eadar-dhealaichte a tha ceangailte gu loidsigeach (me: paca obrach le cùmhnant, NDA, agus aithneachadh leabhar-làimhe). Tha na sgrìobhainnean air an cruinneachadh ann am Batch agus faodar an cur ann an òrdugh sònraichte.

Tha an sruth-obrach a’ feumachdainn trì ceumannan:

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

Cuin a chleachdas tu: A’ cur grunn sgrìobhainnean ceangailte ris an aon neach no buidheann dhaoine. Tha am bratach enforceOrder a’ smachdachadh a bheil feum air sgrìobhainnean a bhith air an ainmeachadh an sreathach no a ghabhas ainmeachadh anns an òrdugh sam bith.

Faic: sendBatch · sendBatchDocument · startBatch · Batch seòrsa

sendBulk — An Aon Sampall gu Mòran Luchd-fhaighinn

A’ cur an aon shampall gu mòran luchd-fhaighinn eadar-dhealaichte aig an aon àm. Feumail airson sgaoilidhean mòr mar ùrachadh poileasaidh bhliadhnail no aithneachadh co-fhreagarrachd.

An sruth-obrach:

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

Cuin a chleachdas tu: A’ cur an aon sgrìobhainn gu ceudan no mìltean de dhaoine eadar-dhealaichte. Nas èifeachdaiche na send a ghairm ann an cuairt oir bidh an àrd-ùrlar a’ giullachd an liosta aig an aon àm.

Faic: startBulk · addBulkDocument · sendBulk

createTask — Gnìomhan Async

Chan e dòigh curidh a th’ ann, ach co-cheangailte. Tha createTask a’ tòiseachadh gnìomhan asyncronach mar gineadh aithisgean. Is e an t-siostam gnìomha an aon fhear a bhios send a’ cleachdadh — bidh an dà chuid a’ toirt air ais ID gnìomha às am faod thu suidheachadh fhaighinn.

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

Faic: createTask · TaskStatus

A’ Taghadh an Dòigh 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)

Chan eil ach send de dh’ amalachadh a dhìth air a’ mhòr-chuid. Cleachd sendBatch agus sendBulk nuair a tha sruth-obrach sònraichte a dhìth a tha a’ feumachdainn buidhneachadh no cuir mòr.

Roghainnean Brathan

Gabhail ris an dà chuid sendBatch agus sendBulk bratan brath a tha a’ smachdachadh giùlan post-d:

Brat	Tuairisgeul
enforceOrder	Feumaidh sgrìobhainnean a bhith air an ainmeachadh san sendOrder sònraichte
notifySender	Cuir post-d chun an neach a chuir e nuair a thèid gach sgrìobhainn ainmeachadh
notifySenderAttach	Ceangail am PDF ainmichte ris an teachdaireachd post-d don neach a chuir e
notifyParticipants	Cuir post-d do na com-pàirtichean nuair a bhios am faidhle deiseil
notifyParticipantsAttach	Ceangail am PDF ainmichte ri brathan do chom-pàirtichean

Tha am mutation send a’ faighinn na h-ìrean seo bho rèiteachadh Experience a’ bhuidhinn.