Tiwtorial Dechrau Cyflym

cyngor

Wedi defnyddio Cursor, Claude, neu offer cod AI arall? Cysylltwch ef â dogfennau Legalesign am gymorth cyd-destun wrth ddilyn y tiwtorial hwn.

Yn y tiwtorial hwn byddwch yn cwblhau'r galwadau API allweddol mae mwyafrif datblygwyr eu angen o uniad eSignature - uwchlwytho dogfen a'i hanfon i arwyddo.

Mae API Legalesign yn raddadwy, amrywiol, ac wedi cael ei brofi mewn systemau cwsmeriaid dros sawl blwyddyn. Gallwch ei ddefnyddio ar gyfer dogfen un arwyddwr syml, neu anfon dogfennau ar gyfer dystio neu gymeradwyaethau, wedi'i optimeiddio ar gyfer swmpiau, gyda ffurflenni a mwy. Gallwch ei integreiddio ar gyfer un diben neu ei fewnosod o fewn eich meddalwedd ar gyfer eich cwsmeriaid - gweler integreiddiadau.

Mae'r REST API yn perfformio'r mwyafrif o swyddogaethau ac yn y ffordd hawsaf i ddechrau. Os oes angen mwy arnoch, edrychwch ar y ryngwyneb GraphQL. Mae Legalesign yn API yn gyntaf gyda GraphQL. Gallwch ddefnyddio un neu'r llall, fel y dymunwch.

Byddwn yn dilyn y camau hyn:

1. Creu cyfrif + Allwedd API (gweler Cael eich dilysu ar gyfer mynediad API).
2. Cadarnhau bod y tystysgrifau'n gweithio a chael eich ID tîm.
3. Uwchlwytho dogfen drwy'r ap gwe.
4. Anfon hynny i gael ei arwyddo drwy'r API.
5. Lawrlwytho ar ôl arwyddo.
6. Uwchlwytho dogfen trwy'r API.

Mae REST API Legalesign yn hawdd i'w ddefnyddio. Mae'r cyfeiriad technegol yn cynnwys golygydd cod. Gallwch wneud ceisiadau yn uniongyrchol o'r cyfeiriad technegol gyda'ch allwedd API, ond os nad hynny, dim ond copïo a gludo'n uniongyrchol i'ch cod.

Ffigur 1: Golygydd Cod REST API.

Llyfrgelloedd cleient

• C# + Sut i
• Java
• Node.js
• PHP
• Python
• Ruby

Neu ar gyfer y rhyngwyneb GraphQL Node.js

cyngor

Rydym yn argymell bod datblygwyr yn gweithio'n uniongyrchol gyda'r API yn hytrach na'r SDKs. I helpu, mae generadur cod torri a gludo yn y maniffest technolegol, ac mae eich AI yn gallu cynhyrchu esiamplau'n gyflym gan ddefnyddio'r [Manyleb OpenAPI] (https://raw.githubusercontent.com/legalesign/Legalesign-V1-OpenAPI3/refs/heads/master/legalesign-api-v1.yaml). Pam? Mae'r API gwreiddiol yn cynnig mwy o swyddogaethau na'r SDKs, byddwch yn dymuno gwybod am yr endpwyntiau rydych yn eu defnyddio beth bynnag, byddwch yn osgoi gor-ofnadwyedd ac dibyniaethau, ac – yng nghyd-destun ein profiad – byddwch yn cyflawni hynny'n gynt hefyd.

1. Creu cyfrif

Ewch i [cyfrif cofrestru legalesign] (https://legalesign.com/landing/free-trial/) a dilynwch y broses i greu cyfrif.

Gofynnir i chi greu tîm. Mae timau yn sail Legalesign. Mae'r broses brosesu dogfennau i gyd yn digwydd mewn tîm. Mae angen i chi gyfeirio at eich tîm mewn rhan fwyaf o alwadau API.

gwybodaeth

Mae 'tîm' neu 'grŵp' yn yr un peth. Yn yr ap gwe rydym yn siarad am 'dimau', ond yn y schema API mae'n 'grŵp'.

Gosodiadau API

Ewch i'r Dangosfwrdd API. Cynhyrchwch eich tystysgrifau API yn adran Allwedd API.

Cymerwch funud i adolygu'r Porth Datblygwr.

Sandbox

Yn adran yr Amgylchedd, mae rhybudd yn dweud a ydych mewn modd sandbox neu gynhyrchu.

Mae Sandbox yn cyfyngu lle gallwch anfon eich dogfennau. Fe welwch ffurflen i ychwanegu hyd at 5 e-bost cymeradwy – ychwanegwch rai nawr.

Pan fydd eich integreiddiad yn barod: symud i fodd cynhyrchu.

cyngor

Creuwch ail dîm. Defnyddiwch eich tîm cyntaf ar gyfer datblygu a team(au) arall(au) ar gyfer cynhyrchu. Rhowch wybod i'r cymorth enw eich tîm datblygu i'w eithrio rhag bilio.

Allwedd API

Yn adran Allwedd API byddwch yn gweld manylion eich allweddi API. Fe welwch yr allwedd ei hun yn unig pan fyddwch yn creu un.

Mae'r adran Dechrau Cyflym yn cynnwys enghreifftiau torri a gludo i brofi eich allwedd.

Webhooks a Logiau

Ychwanegu webhooks (gwrandawyr ar ddigwyddiadau Legalesign), a adolygwch eich logiau.

2. Cais GET llwyddiannus

Mae'r url gwreiddiol bob amser yn: https://eu-api.legalesign.com/

Dechreuwch gyda cais GET i gadarnhau bod eich tystysgrifau'n gweithio. Amnewidiwch y gwerthoedd enw defnyddiwr a chyfrinach yn y cod isod.

Defnyddir Curl yn yr enghreifftiau, a gallwch newid rhwng cURL, Node.js, Python, C#, a Go gan ddefnyddio'r tabiau isod.

cURL

curl -H "Authorization: ApiKey username:secret" -H "Content-Type: application/json" -X GET https://eu-api.legalesign.com/api/v1/group/

Node.js

import fetch from 'node-fetch';

async function getGroups() {
  const response = await fetch('https://eu-api.legalesign.com/api/v1/group/', {
    method: 'GET',
    headers: {
      'Authorization': 'ApiKey username:secret',
      'Content-Type': 'application/json',
    },
  });

  if (!response.ok) {
    throw new Error(`Request failed with status ${response.status}`);
  }

  const data = await response.json();
  console.log(data);
}

getGroups().catch((error) => {
  console.error(error);
  process.exit(1);
});

Python

import requests

headers = {
    "Authorization": "ApiKey username:secret",
    "Content-Type": "application/json",
}

response = requests.get(
    "https://eu-api.legalesign.com/api/v1/group/",
    headers=headers,
    timeout=30,
)
response.raise_for_status()

print(response.json())

C#

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    public static async Task Main()
    {
        using var client = new HttpClient();
        using var request = new HttpRequestMessage(
            HttpMethod.Get,
            "https://eu-api.legalesign.com/api/v1/group/"
        );

        request.Headers.TryAddWithoutValidation("Authorization", "ApiKey username:secret");
        request.Headers.TryAddWithoutValidation("Content-Type", "application/json");

        using var response = await client.SendAsync(request);
        response.EnsureSuccessStatusCode();

        var body = await response.Content.ReadAsStringAsync();
        Console.WriteLine(body);
    }
}

Go

package main

import (
	"fmt"
	"io"
	"log"
	"net/http"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://eu-api.legalesign.com/api/v1/group/", nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Authorization", "ApiKey username:secret")
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()

	if resp.StatusCode >= 400 {
		log.Fatalf("request failed: %s", resp.Status)
	}

	body, err := io.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(string(body))
}

Dogfennaeth API: Cyfeirlyfr API GET group.

Pan fyddwch yn gweithredu'r ymholiad uchod, byddwch yn gweld eich grwpiau'n cael eu dychwelyd yn JSON. Llwyddiant. 👏

Mae data'r ymateb yn cynnwys 'url adnodd' ar gyfer eich grŵp ac mae'n edrych fel /api/v1/group/:groupId/. Nodwch hyn, byddwch angen ar gyfer y rhan fwyaf o alwadau API.

cyngor

Bydd url adnodd bob amser yn cael ei fformatio yr un fath. Ar gyfer PDF byddai'n '/api/v1/templatepdf/:pdfId/', ar gyfer dogfen a anfonwyd bydd yn '/api/v1/document/:documentId/'. Sylwch sut mae pob URL yn gorffen mewn slêcs. Mae hynny hefyd yn wir am URLau eich galwadau API, gorffenwch nhw bob amser gyda slêcs.

Os bydd y cais GET yn methu, gwiriwch fod:

• eich ApiKey wedi'i fformatio'n gywir (yn dechrau gyda 'ApiKey'),
• bod gennych benawd Content-Type ar gyfer application/json, a
• bod eich url yn gorffen gyda slêcs.

Gweler hefyd datrys problemau.

3. Uwchlwytho dogfen drwy'r ap gwe

I ddechrau, byddwn yn uwchlwytho dogfen trwy'r ap gwe a'i hanfon trwy'r API. Byddwn yn trafod sut i uwchlwytho dogfen drwy'r API yn ddiweddarach.

Ewch i'r ap gwe a llwythwch i fyny eich dogfen. Ychwanegwch rôl arwyddwr sengl a llusgwch faes arwydd. Bydd y dudalen olygu yn dangos os yw'r ddogfen yn 'ddilys' (enghraifft o 'annilys' fyddai os ychwanegwch rôl arwyddwr heb faes arwydd cysylltiedig).

Ar y golygydd ffurflen, copïwch y cod alffanumerig hir o'r URL, dadgodwch ef gan base64 a gwaredu'r 3 llythyren gyntaf (sy'n rhaid iddynt fod 'tpl'). Y gweddill yw UUID sef eich ID.

Mewn iaith REST API, url adnodd y ddogfen hon yw /api/v1/templatepdf/UUID/.

Yn dysgu mwy am IDs gwe ac API.

Ein nomenclatura ni yw bod dogfen uwchlwytho yn 'templedi' a phan anfonwch un rydych yn creu 'dogfen'.

cyngor

Os ydych am archifo templed wrth anfon y ddogfen gosodwch 'archive_upon_send' fel nodweddyn yn y cais uwchlwytho. Os ydych am i'r templed peidio byth ymddangos a'i ddileu ar ôl ei anfon, rhoddwch y teitl '[deleted]' - bydd ein systemau glanhau'n canfod hyn ac yn ei ddileu ar ôl diwrnod neu ddau. Gallwch hefyd osod amseroedd cadwied byr yn lefel y grŵp - dysgwch fwy.

4. Anfon dogfen i'w llofnodi

Nawr byddwn yn anfon hwn trwy'r API. Cofiwch ddefnyddio e-bost yn eich e-byst 'cymeradwy' sandbox. Defnyddiwch y tabiau isod i gael y cais yn eich iaith hoff.

cURL

curl -H "Authorization: ApiKey [username]:[secret]" -H "Content-Type: application/json" -X POST --data '{ "group": "/api/v1/group/[:groupId]/", "name": "Name of doc", "templatepdf": "/api/v1/templatepdf/UUID/", "signers": [{"firstname": "Joe", "lastname": "Bloggs", "email": "[your@email.com]", "order": 0 }], "do_email": true }' https://eu-api.legalesign.com/api/v1/document/

Node.js

import fetch from 'node-fetch';

const payload = {
  group: '/api/v1/group/[:groupId]/',
  name: 'Name of doc',
  templatepdf: '/api/v1/templatepdf/UUID/',
  signers: [
    {
      firstname: 'Joe',
      lastname: 'Bloggs',
      email: '[your@email.com]',
      order: 0,
    },
  ],
  do_email: true,
};

async function sendDocument() {
  const response = await fetch('https://eu-api.legalesign.com/api/v1/document/', {
    method: 'POST',
    headers: {
      'Authorization': 'ApiKey [username]:[secret]',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(payload),
  });

  if (response.status !== 201) {
    const errorBody = await response.text();
    throw new Error(`Request failed with status ${response.status}: ${errorBody}`);
  }

  console.log('Document sent successfully');
  const location = response.headers.get('location');
  if (location) {
    console.log(`Location: ${location}`);
  }
}

sendDocument().catch((error) => {
  console.error(error);
  process.exit(1);
});

Python

import requests

payload = {
    "group": "/api/v1/group/[:groupId]/",
    "name": "Name of doc",
    "templatepdf": "/api/v1/templatepdf/UUID/",
    "signers": [
        {
            "firstname": "Joe",
            "lastname": "Bloggs",
            "email": "[your@email.com]",
            "order": 0,
        }
    ],
    "do_email": true,
}

headers = {
    "Authorization": "ApiKey [username]:[secret]",
    "Content-Type": "application/json",
}

response = requests.post(
    "https://eu-api.legalesign.com/api/v1/document/",
    json=payload,
    headers=headers,
    timeout=30,
)
response.raise_for_status()

print("Document sent successfully")
print("Location:", response.headers.get("Location"))

C#

using System;
using System.Net.Http;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;

public class Program
{
    public static async Task Main()
    {
        var payload = new
        {
            group = "/api/v1/group/[:groupId]/",
            name = "Name of doc",
            templatepdf = "/api/v1/templatepdf/UUID/",
            signers = new[]
            {
                new
                {
                    firstname = "Joe",
                    lastname = "Bloggs",
                    email = "[your@email.com]",
                    order = 0,
                },
            },
            do_email = true,
        };

        using var client = new HttpClient();
        using var request = new HttpRequestMessage(
            HttpMethod.Post,
            "https://eu-api.legalesign.com/api/v1/document/"
        );
        request.Headers.TryAddWithoutValidation("Authorization", "ApiKey [username]:[secret]");

        var json = JsonSerializer.Serialize(payload);
        request.Content = new StringContent(json, Encoding.UTF8, "application/json");

        using var response = await client.SendAsync(request);
        response.EnsureSuccessStatusCode();

        Console.WriteLine("Document sent successfully");
        if (response.Headers.Location is not null)
        {
            Console.WriteLine($"Location: {response.Headers.Location}");
        }
    }
}

Go

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"log"
	"net/http"
)

func main() {
	payload := map[string]any{
		"group": "/api/v1/group/[:groupId]/",
		"name":  "Name of doc",
		"templatepdf": "/api/v1/templatepdf/UUID/",
		"signers": []map[string]any{
			{
				"firstname": "Joe",
				"lastname":  "Bloggs",
				"email":     "[your@email.com]",
				"order":     0,
			},
		},
		"do_email": true,
	}

	body, err := json.Marshal(payload)
	if err != nil {
		log.Fatal(err)
	}

	req, err := http.NewRequest(
		http.MethodPost,
		"https://eu-api.legalesign.com/api/v1/document/",
		bytes.NewReader(body),
	)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Authorization", "ApiKey [username]:[secret]")
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()

	if resp.StatusCode != http.StatusCreated {
		log.Fatalf("unexpected status: %s", resp.Status)
	}

	fmt.Println("Document sent successfully")
	fmt.Println("Location:", resp.Header.Get("Location"))
}

Diweddarwch y rhifynnau mewn croesliniau. Cyfeiriad API i anfon dogfen.

cyngor

Pan fyddwch yn ymweld â'r dogfennaeth gyfeirio i anfon dogfen edrychwch yn dda drwy'r holl nodweddion posibl. Fe welwch lawer a fydd yn helpu gyda'r ymarferoldeb mewn uniad - tagiau ar gyfer eich cyfeiriadau eich hun a IDs (sy'n cael eu dychwelyd yn webhooks), ailgyfeirio ar gyfer arwyddwyr, gosod testun personol yn y PDF, a mwy.

Bydd galwad llwyddiannus yn dychwelyd cod statws 201. ✨

Cael ID dogfen anfon newydd

Y rhan bwysig o'r ymateb yw'r pennawd lleoliad. Mae hwn yn cynnwys eich id dogfen newydd.

cyngor

Defnyddiwch nodweddion 'tag' dogfen a ychwanegwch eich cyfeiriadau eich hun i wneud cysylltiad haws â'ch cronfa ddata eich hun.

Bydd y pennawd lleoliad yn edrych fel /api/v1/status/:documentId/.

Mae'r URI 'status' yn dychwelyd set fer (a chyflym i ymholi) o nodweddion dogfen.

I ofyn am bopeth o ddogfen defnyddiwch /api/v1/document/:documentId/.

gwybodaeth

Os yw cais yn methu bydd y CORFF yn yr ymateb fel arfer yn cynnwys gwybodaeth am wall. Os na gewch statws llwyddiant, gwiriwch y CORFF am destun esboniadol. Gweler hefyd datrys problemau.

Dysgwch fwy am alwad API Anfon Dogfen.

5. Lawrlwytho'r ddogfen wedi'i llofnodi

Gyda'r ID dogfen a anfonwyd a gawsoch uchod, gwnewch gais lawrlwytho PDF yn y iaith a ddewiswch:

cURL

curl -H "Authorization: ApiKey [username]:[secret]" -o download.pdf -X GET https://eu-api.legalesign.com/api/v1/pdf/:documentId/

Node.js

import { writeFile } from 'node:fs/promises';
import fetch from 'node-fetch';

async function downloadPdf() {
  const response = await fetch('https://eu-api.legalesign.com/api/v1/pdf/:documentId/', {
    method: 'GET',
    headers: {
      'Authorization': 'ApiKey [username]:[secret]',
    },
  });

  if (!response.ok) {
    throw new Error(`Request failed with status ${response.status}`);
  }

  const buffer = await response.arrayBuffer();
  await writeFile('download.pdf', Buffer.from(buffer));
  console.log('Saved download.pdf');
}

downloadPdf().catch((error) => {
  console.error(error);
  process.exit(1);
});

Python

import requests

headers = {"Authorization": "ApiKey [username]:[secret]"}

response = requests.get(
    "https://eu-api.legalesign.com/api/v1/pdf/:documentId/",
    headers=headers,
    stream=True,
    timeout=30,
)
response.raise_for_status()

with open("download.pdf", "wb") as file:
    for chunk in response.iter_content(chunk_size=8192):
        file.write(chunk)

C#

using System;
using System.IO;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    public static async Task Main()
    {
        using var client = new HttpClient();
        using var request = new HttpRequestMessage(
            HttpMethod.Get,
            "https://eu-api.legalesign.com/api/v1/pdf/:documentId/"
        );
        request.Headers.TryAddWithoutValidation("Authorization", "ApiKey [username]:[secret]");

        using var response = await client.SendAsync(request);
        response.EnsureSuccessStatusCode();

        var bytes = await response.Content.ReadAsByteArrayAsync();
        await File.WriteAllBytesAsync("download.pdf", bytes);
        Console.WriteLine("Saved download.pdf");
    }
}

Go

package main

import (
	"io"
	"log"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest(
		http.MethodGet,
		"https://eu-api.legalesign.com/api/v1/pdf/:documentId/",
		nil,
	)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Authorization", "ApiKey [username]:[secret]")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()

	if resp.StatusCode >= 400 {
		log.Fatalf("request failed: %s", resp.Status)
	}

	file, err := os.Create("download.pdf")
	if err != nil {
		log.Fatal(err)
	}
	defer file.Close()

	if _, err := io.Copy(file, resp.Body); err != nil {
		log.Fatal(err)
	}

	log.Println("Saved download.pdf")
}

Cyfeiriad API Lawrlwytho PDF.

Mae’r ffeil ddwyreiniol PDF yn y corff ymateb. Mae'r gorchymyn curl '-o' yn rhoi CORFF yr ymateb yn uniongyrchol i ffeil.

Mae llawer o lyfrgelloedd REST neu HTTP yn trin gwrthrychau ymateb HTTP fel pe baent yn ffeiliau ac yn yr achos hwnnw dim ond cadw'ch gwrthrych ymateb fel ffeil arferol.

cyngor

Defnyddiwch wehooks i gael hysbysiad o ddigwyddiad llofnodi ac yna lawrlwythwch y ddogfen. Gweler webhooks.

6. Uwchlwytho PDF

[Cliciwch yma i lawrlwytho PDF testun-tagio enghreifftiol] (https://static.legalesign.com/tutorialQuickstartPdf.pdf), mwy am faes ffurflenni PDF i ddilyn.

Ar gyfer y galwad hon, troi'ch PDF yn string wedi'i godio base64. Nid yw hyn yn cael ei wneud yn iawn yn yr offeryn cynhyrchu cod dogfennaeth. Yn lle hynny copïwch y pseudocod hwn ac fe fydd eich AI yn ei droi i'ch iaith ddewisiol:

$data = (
  'group': '/api/v1/group/:groupId/',
  'title': 'title of pdf',
  'pdf_file': base64encode(open('/path/to/file','rb')),
  'process_tags': true
)
$headers = (
  'Authorization': 'ApiKey username:secret',
  'Content-Type': 'application/json'
)
response = httplibrary.post('https://eu-api.legalesign.com/api/v1/templatepdf/', jsonEncode($data), $headers)
assert response.status == 201

pdfId = response.headers['location']

Cyfeiriad API uwchlwytho PDF.

Fel arfer, bydd ymateb POST llwyddiannus yn dychwelyd statws '201' ac ID newydd yn y pennawd 'lleoliad' yn yr ymateb.

assert response.status == 201
pdfId = response.headers['location']

Bydd eich url adnodd PDF yn edrych fel /api/v1/templatepdf/:pdfId/.

Anfon y PDF newydd

Dychwelyd i'r cod a ddefnyddiwyd i anfon eich dogfen gyntaf, a disodli'r gwerth templatepdf.

Rhowch y cais eto a dyna chi, rydych wedi anfon eich PDF allan i'w lofnodi.

Cyn i chi ddechrau codio, fodd bynnag, darllenwch ymlaen i ddysgu mwy am faes PDF.

Beth am feysydd PDF?

Sut mae Legalesign yn gwybod ble mae angen i'r person lofnodi ar y PDF, neu adrannau i'w newid wrth anfon? Ymateb yw ein bod wedi paratoi'n flaenorol y PDF gyda thagiau: rydym yn rhoi tag testun Legalesign o fewn y PDF a gosodwn 'process_tags' i wir yn y cais uwchlwytho PDF.

[Lawrlwythwch PDF tagio testun enghreifftiol] (https://static.legalesign.com/tutorialQuickstartPdf.pdf).

Mae tagiau testun yn destun wedi’i fformatio’n arbennig i roi mewn PDF. Bydd Legalesign yn dadansoddi'r testun yn eich ffeil, gan ddisodli'r tagiau gyda meysydd llofnod a ffurflen. Ar gyfer un arwyddwr, y cyfan sydd ei angen yw ychwanegu: <<t=signature>>. Bydd Legalesign yn ei adnabod ac yn lleoli'r llofnod yno. Dysgu am dagiau testun.

Mae tagiau testun yn gofyn am ychydig o ymarfer ac yn cynnwys ymarfer a chamgymeriadau. Mae dulliau eraill wedi'u rhestru isod, ond cewch ddefnydd llawn o system ffurflenni Legalesign gyda nhw. Defnyddiwch yr ap gwe i brofi tagiau. Cysylltwch â [chymorth] (https://support.legalesign.com) am gymorth ac enghreifftiau.

Dyma 4 ffordd arall i sefydlu meysydd:

1. Fersiwn hawddaf / cyflymaf. Gosodwch eich PDF gan ddefnyddio'r ap gwe Legalesign.

Ar ôl i chi uwchlwytho PDF fe gewch i'r rhyngwyneb golygydd lle gallwch lusgo a gollwng meysydd ffurflen.

Llusgwch a gollwng llofnod, yna nodwch yr ID wedi'i godio yn y cyfeiriad gwe. Bydd hwn yn edrych fel rhywbeth fel 'dHBsMTRlZTQ0ZWUtZGE0Ni0xMWVmLTllZmUtMDI5ZGQ0ODkzZGRk'.

Dadgodwch yr ID hwn gan base64 a byddwch yn gweld ei bod yn UUID gyda rhaglun 'tpl'. Y rhan UUID (tynnwch 'tpl') yw eich pdfID. Dysgu mwy am IDs Legalesign.

Bydd url adnodd PDF API yn - /api/v1/templatepdf/:pdfId/.

Rhowch hwnnw yn yr nodwedd 'templatepdf' o'r galwad anfon dogfen.

gwybodaeth

Os ydych yn bwriadu anfon y PDF hwn fwy nag unwaith, sicrhewch fod 'Archif Auto' wedi'i ddiffodd. Gweler sut

2. Defnyddiwch gydlynu x/y ar gyfer meysydd.

Y ffordd symlaf i ddechrau gyda chyfystyron x/y yw gosod PDF yn yr ap gwe ac yna ymholi API am y meysydd hynny (GET Mae Meysydd PDF - /api/v1/templatepdf/:pdfId/fields/).

Mae'r gwrthrych JSON a dderbyniwch yn union yr un schema JSON sydd ei angen i greu meysydd hefyd.

Defnyddiwch fel templed. Addaswch werthoedd ac anfonwch yn ôl drwy POST i'r un penlinell (addasu'r ID PDF yn briodol). Creu pwynt penlinell maes PDF.

3. Mewnosodwch ein tudalen golygu PDF. NEWYDD!

Defnyddiwch ein cydran golygydd i fewnosod ein golygydd PDF yn uniongyrchol i'ch ap eich hun. Dysgu mwy am y cydran golygydd dogfen.

4. Meysydd Ffurflen PDF NEWYDD!

Os yw eich PDF yn cynnwys Meysydd Ffurflen PDF arferol, gall Legalesign eu mewnforio'n awtomatig.

Codio Llawen!

Yn y tiwtorial hwn cesglwyd tystysgrifau API, gwneuthum ymweliad llwyddiannus am eich grŵp(iau), anfonwyd dogfen allan i lofnodi gan ddefnyddio HTML a PDF, a lawrllwythwyd dogfen a lofnodwyd.

Codwch yn hapus! Rydym yma i helpu, cysylltwch â [chymorth] (https://support.legalesign.com) am unrhyw gymorth.

cyngor

Da iawn, cyrhaeddoch y diwedd - diolch am ddarllen hwn. Ein cais terfynol, a chyngor, yn seiliedig ar flynyddoedd o brofiad trwy ddatblygwyr yn integreiddio â'r API hwn, yw y cymerwch funud i ddarllen drwy'r holl nodweddion ar y pwynt terfyn creu dogfen (a cliciwch i weld beth ddaw 'arwyddwyr', 'pdftext' a 'signertext' i gynnwys) - mae'n y galwad fwyaf pwysig yn eich uniad. Creu dogfen llofnodi.

Camau nesaf:

• Webhooks ar gyfer hysbysiadau amser real
• Mewnosod y golygydd ffurflenni
• Mewnosod y dudalen lofnodi