Neidio i’r prif gynnwys

Integreiddio'r Gwylwr Dogfennau

Y Gwylwr Dogfennau yw cydran gwe sy’n caniatáu i ddefnyddwyr olygu templedi a pharatoi dogfennau ar gyfer arwyddo — yn uniongyrchol o fewn eich cais. Mae'r canllaw hwn yn dangos sut i’w gysylltu â'r API GraphQL i adeiladu llif gwaith arwyddo cyflawn.

Trosolwg​

Mae integreiddiad nodweddiadol yn dilyn y camau hyn:

  1. Awduroni — cael tocyn ar gyfer y gwylwr
  2. Llwytho templed i fyny — drwy'r API GraphQL
  3. Arddangos y gwylwr — pasio ID y templed a'r tocyn
  4. Dal digwyddiadau — mae'r gwylwr yn anfon digwyddiadau update a validate wrth i’r defnyddiwr weithio
  5. Anfon y ddogfen — galw'r newidyn send gyda gwybodaeth y derbynnydd a'r rôl o'r gwylwr

Awduroni​

Mae angen tocyn dilys ar y gwylwr a gaiff ei basio i'w briodwedd token. Gweler Awduroni gydag API cyn cysylltu’r gwylwr â’ch cais.

Modd Cyfansoddi — Anfon Dogfen Wedi'i Adeiladu Eisoes​

Mae modd cyfansoddi ar gyfer llifoedd gwaith lle mae eich system eisoes yn gwybod y derbynwyr. Mae’r defnyddiwr yn lleoli meysydd arwydd yn unig ac yn anfon.

1. Arddangos y gwylwr​

<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. Olrhain dilysiad a IDau rôl​

Wrth i’r defnyddiwr ychwanegu meysydd, mae’r gwylwr yn anfon digwyddiadau. Mae angen dwy beth arnoch o’r digwyddiadau hyn:

  • validate — yn dweud wrthych os yw’r templed yn cynnwys yr holl feysydd gofynnol (o leiaf un llofnod i bob derbynnydd)
  • update — yn darparu cyflwr presennol y templed, gan gynnwys roleId ar gyfer pob cyfranogwr pan fyddwch angen mapio rôl y templed
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;
  });
});

Mae’r roleId o’r digwyddiad update yn cysylltu pob derbynnydd ag eu meysydd ar y templed. Cynnwys hwn pan fydd angen y mapio hwn yn eich llif anfon.

3. Anfon y ddogfen​

Pan glicia'r defnyddiwr ar anfon, galwch y newidyn send gyda gwybodaeth y derbynnydd a’r IDau rôl a ddalwyd o’r gwylwr:

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);
});

Mae’r newidyn send yn dychwelyd ID tasg. Rhowch holiadur i’r ymholiad task a monitro task.report.status nes iddo gyrraedd COMPLETED neu FAILED i gadarnhau bod creu’r ddogfen wedi gorffen.

Modd Golygydd — Creu Templed​

Mae modd golygydd yn rhoi profiad cyflawn o olygu templed i ddefnyddwyr — gan ychwanegu rolau, lleoli meysydd, a ffurfweddu opsiynau. Defnyddiwch hwn pan gewch chi ddefnyddwyr i adeiladu templedi a ellir eu hailddefnyddio.

<ls-document-viewer
  id="editor"
  templateid="dHBsYjQ5YTg5NWQtYWRhMy0xMWYwLWIxZGMtMDY5NzZlZmU0MzIx"
  token="YOUR_ACCESS_TOKEN"
  mode="editor"
></ls-document-viewer>

Yn y modd golygydd, mae’r digwyddiad update yn tanio bob tro mae'r templed yn newid. Gallwch ddefnyddio hyn i olrhain cyflwr y templed neu ddangos dangosydd arbed:

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);
});

Mae newidiadau i'r templed yn cael eu cadw’n awtomatig gan y gwylwr — nid oes angen i chi alw unrhyw newidyn GraphQL i gadw’r golygiadau.

Integreiddiad React​

Mae’r lapio React yn darparu’r un swyddogaeth gydag ymdrin digwyddiadau ar ffurf 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>
  );
};

Tystiaid​

I ychwanegu dyst i llofnodwr, gosodwch roleType: "WITNESS" a defnyddiwch signerIndex cyfwerth i rif y llofnodwr rhiant + 100. Er enghraifft, mae tyst i’r llofnodwr 2 yn cael signerIndex: 102:

<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>

Cysyniadau Allweddol​

Cysyniad gwylwrMath GraphQLDisgrifiad
priodwedd templateidTemplateY templed sy’n cael ei olygu neu ei gyfansoddi
priodwedd recipientsRecipientInputDerbynwyr a basiwyd i fodd cyfansoddi
roleId o ddigwyddiad updateRoleYn cysylltu derbynnydd â’u meysydd ar y templed
digwyddiad validate—Os oes gan y templed yr holl feysydd gofynnol
newidyn sendsendYn anfon y ddogfen ar ôl cyfansoddi
priodwedd token—Tocyn o awduroni
mode="compose"—Modd symlach ar gyfer gosod meysydd ac anfon
mode="editor"—Modd golygu templed llawn
experience yn y mewnbwn anfonExperienceYn rheoli brandio, e-byst, a’r dudalen arwyddo — gweler Esboniad ar brofiadau

Export This Article

Save a copy of this page as PDF or plain text.