Comhtháthú an Amharc Doiciméad
Is comhpháirt gréasáin é an Document Viewer a ligeann do úsáideoirí teimpléid a chur in eagar agus doiciméid a ullmhú le síniú — go díreach laistigh d’fhheidhmchlár tú féin. Taispeánann an treoir seo conas é a nascadh leis an API GraphQL chun sreabhadh oibre sínithe iomlán a thógáil.
Forbhreathnú
Leanann comhtháthú traidisiúnta na céimeanna seo a leanas:
- Díghlasáil — token a fháil don lucht féachana
- Teimpléad a uaslódáil — trína API GraphQL
- An lucht féachana a léiriú — aitheantóir an teimpléid agus token a chur ar aghaidh
- Imeachtaí a ghabháil — scaoileann an lucht féachana imeachtaí
updateagusvalidateagus an t-úsáideoir ag obair - An doiciméad a sheoladh — glaoigh ar an mhaltung
sendleis na sonraí faighteoir agus ról ón lucht féachana
Fíordheimhniú
Teastaíonn token bailí ón lucht féachana a chur isteach ina airí ligean token. Soláthraíonn do chúlra token comhpháirt ghearrchónaí ó generateComponentToken. Féach ar Údarú Widget sula nascann tú an lucht féachana isteach i do fheidhmchlár.
Mód Comhdhéanta — Doiciméad Réamhthógtha a Sheoladh
Is é an mód comhdhéanta oibreacha ina bhfuil do chórais ar an eolas cheana faoin lucht féachana. Cuireann an t-úsáideoir réimsí sínithe agus seolann sé.
1. An lucht féachana a léiriú
<ls-document-viewer
id="viewer"
templateid="dHBsYjQ5YTg5NWQtYWRhMy0xMWYwLWIxZGMtMDY5NzZlZmU0MzIx"
token="YOUR_ACCESS_TOKEN"
mode="compose"
recipients='[
{"email": "jane@example.com", "firstname": "Jane", "lastname": "Smith", "signerIndex": 1},
{"email": "john@example.com", "firstname": "John", "lastname": "Doe", "signerIndex": 2}
]'
filtertoolbox="signature|initials|date|text"
>
<span slot="right-button">
<button id="send-btn" disabled>Send</button>
</span>
</ls-document-viewer>
2. Rianú bailíochtaithe agus aitheantóirí róil
De réir mar a chuir an t-úsáideoir réimsí leis, scaoileann an lucht féachana imeachtaí. Tá dhá rud uait ó na himeachtaí seo:
validate— insíonn sé duit an bhfuil na réimsí riachtanacha go léir sa teimpléad (ag a laghad, síniú amháin in aghaidh an fhaighteora)update— soláthraíonn sé stádas reatha an teimpléid, lena n-áirítearroleIddo gach rannpháirtí nuair is gá léaráid ról teimpléid
const viewer = document.getElementById('viewer');
const sendBtn = document.getElementById('send-btn');
let isValid = false;
const recipientRoles = {};
viewer.addEventListener('validate', (e) => {
isValid = e.detail.valid;
sendBtn.disabled = !isValid;
});
viewer.addEventListener('update', (e) => {
const roles = e.detail.template.roles;
roles.forEach((role) => {
recipientRoles[role.signerIndex] = role.id;
});
});
Is é an roleId ón imeacht update a dhéanann léaráid ar gach faighteoir lena réimsí ar an teimpléad. Cuir isteach é nuair is gá an léaráid sin i do shruth seolta.
3. An doiciméad a sheoladh
Nuair a chliceálann an t-úsáideoir ar sheol, glaoigh ar an mhaltung send leis na sonraí faighteora agus na haitheantóirí róil a gabhadh ón lucht féachana:
sendBtn.addEventListener('click', async () => {
const token = '<token-from-authentication-guide>';
const recipients = [
{
firstName: 'Jane',
lastName: 'Smith',
email: 'jane@example.com',
role: 'Signer',
roleId: recipientRoles[1],
signerIndex: 1,
order: 1,
},
{
firstName: 'John',
lastName: 'Doe',
email: 'john@example.com',
role: 'Signer',
roleId: recipientRoles[2],
signerIndex: 2,
order: 2,
},
];
const response = await fetch('https://graphql.uk.legalesign.com/graphql', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${token}`,
},
body: JSON.stringify({
query: `mutation SendDocument {
send(input: {
groupId: "YOUR_GROUP_ID"
templateId: "dHBsYjQ5YTg5NWQtYWRhMy0xMWYwLWIxZGMtMDY5NzZlZmU0MzIx"
title: "Contract - Jane Smith & John Doe"
recipients: ${JSON.stringify(recipients).replace(/"(\w+)":/g, '$1:')}
sequentialSigning: true
})
}`,
}),
});
const result = await response.json();
const taskId = result.data.send;
// Poll for completion
console.log('Task started:', taskId);
});
Tugtar ID tasc ar ais ón mhaltung send. Déan an fiosrúchán task a pholláil agus bain súil ar task.report.status go dtí go sroicheann sé COMPLETED nó FAILED chun a dhearbhú gur críochnaíodh cruthú an doiciméid.
Mód Eagarthóra — Cruthú Teimpléid
Cuireann mód eagarthóra ar chumas úsáideoirí an taithí eagarthóireachta teimpléid iomlán — rólanna a chur leis, réimsí a chur isteach, roghanna a chumrú. Bain úsáid as seo nuair is mian leat go ndéanfaidh úsáideoirí teimpléid inúsáidte a thógáil.
<ls-document-viewer
id="editor"
templateid="dHBsYjQ5YTg5NWQtYWRhMy0xMWYwLWIxZGMtMDY5NzZlZmU0MzIx"
token="YOUR_ACCESS_TOKEN"
mode="editor"
></ls-document-viewer>
Ar mhód eagarthóra, sileann imeacht update gach uair a athraíonn an teimpléad. Is féidir leat é seo a úsáid chun stádas an teimpléid a rianú nó taispeáint go sábháladh é:
const editor = document.getElementById('editor');
editor.addEventListener('update', (e) => {
console.log('Template updated:', e.detail);
});
editor.addEventListener('validate', (e) => {
console.log('Template valid:', e.detail.valid);
});
Sábháiltear athruithe teimpléid go huathoibríoch ag an lucht féachana — níl ort glaoch a dhéanamh ar aon mhaltung GraphQL chun eagarthóireacht a chaomhnú.
Comhtháthú React
Soláthraíonn an clúdach React an fheidhmiúlacht chéanna le láimhseáil imeachtaí i stíl React:
import { useState } from 'react';
import { LsDocumentViewer } from 'legalesign-document-viewer-react';
const DocumentCompose = ({ templateId, recipients, token }) => {
const [isValid, setIsValid] = useState(false);
const [roleMap, setRoleMap] = useState({});
const handleValidate = (e) => {
setIsValid(e.detail.valid);
};
const handleUpdate = (e) => {
const roles = e.detail.template.roles;
const map = {};
roles.forEach((role) => {
map[role.signerIndex] = role.id;
});
setRoleMap(map);
};
const handleSend = async () => {
const mappedRecipients = recipients.map((r, i) => ({
...r,
roleId: roleMap[r.signerIndex],
order: i + 1,
}));
const response = await fetch('https://graphql.uk.legalesign.com/graphql', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${token}`,
},
body: JSON.stringify({
query: `mutation SendDocument {
send(input: {
groupId: "YOUR_GROUP_ID"
templateId: "${templateId}"
title: "Document"
recipients: ${JSON.stringify(mappedRecipients).replace(/"(\w+)":/g, '$1:')}
})
}`,
}),
});
const result = await response.json();
console.log('Task ID:', result.data.send);
};
if (!token) return null;
return (
<LsDocumentViewer
templateid={templateId}
token={token}
mode="compose"
recipients={JSON.stringify(recipients)}
onValidate={handleValidate}
onUpdate={handleUpdate}
>
<div slot="right-button">
<button onClick={handleSend} disabled={!isValid}>
Send
</button>
</div>
</LsDocumentViewer>
);
};
Fianaise
Chun fianaise a chur le síneoir, socraigh roleType: "WITNESS" agus bain úsáid as signerIndex a bhfuil innéacs an síneora tuismitheora + 100 aige. Mar shampla, tá signerIndex: 102 ag fianaise do shíneoir 2:
<ls-document-viewer
mode="compose"
recipients='[
{"email": "signer@example.com", "firstname": "Alice", "lastname": "Jones", "signerIndex": 1},
{"email": "signer2@example.com", "firstname": "Bob", "lastname": "Brown", "signerIndex": 2},
{"email": "witness@example.com", "firstname": "Carol", "lastname": "White", "signerIndex": 102, "roleType": "WITNESS"}
]'
...
></ls-document-viewer>
Coincheapa Eochair
| Coincheap lucht féachana | Cineál GraphQL | Cur síos |
|---|---|---|
Airí ligean templateid | Template | An teimpléad atá á eagarthóireacht nó á chomhdhéanta |
Airí ligean recipients | RecipientInput | Faighteoirí a chuirtear isteach i mód comhdhéanta |
roleId ón imeacht update | Role | Nascann faighteoir lena réimsí ar an teimpléad |
Imeacht validate | — | An bhfuil na réimsí riachtanacha go léir sa teimpléad |
Mhaltung send | send | Seolann an doiciméad tar éis an chomhchóimeála |
Airí ligean token | — | Token ó fhíordheimhniú |
mode="compose" | — | Mód sruthlínithe chun réimsí a chur agus a sheoladh |
mode="editor" | — | Mód eagarthóireachta iomlán teimpléid |
experience i n-ionchur sheolta | Experience | Rialáil chló, ríomhphoist, agus leathanach sínithe — féach Experiences explained |
Gaolmhar
- Tagairt don Document Viewer — tagairt iomlán ar airí ligean agus imeachtaí
- maltung
send— doiciméad a sheoladh - DocumentSendSettingsInput — struchtúr iomlán ionchur sheolta
- Móid sheoltacha mínithe — seol i gcoinne sendBatch i gcoinne sendBulk
- Comhad a uaslódáil mar Theimpléad — teimpléid a uaslódáil tríd an API
- Fíordheimhniú — modh fíordheimhnithe a roghnú