Tiwtorial Dechrau Cyflym

Mae mynediad i'r API yn gofyn am gymeradwyaeth

I ddefnyddio'r Legalesign API mae angen i chi gysylltu â ni i gael eich defnydd o'r API wedi'i gymeradwyo ar gyfer eich cyfrif.

cyngor

Ydych chi'n defnyddio Cursor, Claude, neu offeryn codio AI arall? Cysylltwch ef ag adran ddogfennau Legalesign i gael help sy’n ymwybodol o gyd-destun wrth i chi ddilyn y tiwtorial hwn.

Yn y tiwtorial hwn byddwch yn cwblhau'r galwadau API allweddol y mae mwyafrif datblygwyr eu hangen o integreiddiad eSignature - llwytho dogfen i fyny a'i hanfon allan ar gyfer llofnodi.

Mae'r Legalesign API yn raddadwy, amrywiol, ac wedi cael ei brofi mewn cynhyrchiad yn systemau ein cwsmeriaid ers blynyddoedd. Gellir ei ddefnyddio ar gyfer dogfen gyda un llofnodydd syml, neu anfon dogfennau ar gyfer dystio neu gymeradwyaethau, wedi'i optimeiddio ar gyfer swmpiau, gyda ffurflenni a mwy. Gellir integreiddio ar gyfer un diben neu ei fewnosod yn eich meddalwedd eich hun ar gyfer eich cwsmeriaid - gweler integreiddiadau.

Mae'r REST API yn perfformio’r rhan fwyaf o swyddogaethau ac yn ffordd hawdd i ddechrau. Os oes angen mwy arnoch, ewch i’r rhyngwyneb GraphQL. Mae Legalesign yn API gyntaf gyda GraphQL. Gallwch ddefnyddio'r un ai'r llall, yn ôl eich dewis.

Byddwn yn dilyn y camau hyn:

Creu cyfrif + Allwedd API (gweler Cael eich dilysu ar gyfer mynediad API).
Cadarnhau bod y credydau'n gweithio a chael eich ID tîm.
Llwytho dogfen i fyny drwy'r ap gwe.
Anfon hynny i'w lofnodi drwy'r API.
Lawrlwytho ar ôl llofnodi.
Llwytho dogfen i fyny drwy'r API.

Mae Legalesign REST API yn hawdd i'w ddefnyddio. Mae'r cyfeirlyfr technegol yn cynnwys golygydd cod. Gallwch wneud ceisiadau'n union o'r cyfeirlyfr technegol gyda'ch allwedd API, ond yn arall dim copi a gludwch yn syth i'ch cod.

Delwedd Cynhyrchydd Cod Ffigur 1: Golygydd Cod y REST API.

Llyfrgelloedd cleient

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 cynhyrchydd cod i gopïo a gludo yn y manylion technegol, a bydd eich AI cyfeillgar yn gallu creu enghreifftiau'n gyflym gan ddefnyddio'r spegyn OpenAPI. Pam? Mae ganddo fwy o nodweddion na’r SDKs, byddwch am wybod am y penbontau a ddefnyddiwch beth bynnag, byddwch yn osgoi gorlenwi ac ymddibyniaethau, ac—ar sail ein profiad—byddwch yn gallu gwneud y gwaith yn gynt hefyd.

1. Creu cyfrif

Ewch i cofrestru gyda legalesign. Defnyddiwch e-bost cyffredin i greu'r cyfrif (peidiwch â defnyddio Google), ni fydd hunaniaethau federeiddiedig fel Google yn gweithio gyda'r API.

Gofynnir i chi greu tîm. Mae timau'n graidd i Legalesign. Mae'r holl brosesu dogfennau’n digwydd mewn tîm. Bydd angen cyfeirio at eich tîm yn y mwyafrif o alwadau API.

gwybodaeth

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

[Cysylltwch â chefnogaeth]https://support.legalesign.com) am Allwedd API. Dywedwch wrthym eich achos defnydd, eich profiad mewn datblygu API, a rhai manylion i gael cadarnhad eich bod yn berson go iawn (e.e. manylion lle rydych yn gweithio).

Gosodiadau API

Unwaith y byddwch wedi eich dilysu ewch i'r Dangosfwrdd API. Cynhwyswch eich credydau API yn adran Allwedd API.

Cymerwch eich amser i adolygu’r Porth Datblygwr.

Sandbox

Yn yr Adran Amgylchedd, dangosir rhybudd a ydych chi mewn modd sandbox neu gynhyrchiad.

Mae’r sandbox yn cyfyngu ble allwch anfon eich dogfennau. Byddwch yn gweld ffurflen i ychwanegu hyd at 5 e-bost sydd wedi’u cymeradwyo - ychwanegwch ychydig nawr.

Pan fydd eich integreiddiad yn barod: symud i’r modd cynhyrchiad.

cyngor

Creu ail dîm. Defnyddiwch eich tîm cyntaf ar gyfer datblygiad ac eraill ar gyfer cynhyrchiad. Dywedwch wrth gefnogaeth enw eich tîm datblygiad i’w eithrio rhag bilio.

Allwedd API

Yn adran Allwedd API byddwch yn gweld manylion eich allweddi API. Dim ond y allwedd ei hun fydd yn cael ei ddangos wrth i chi greu un.

Mae’r adran Dechrau Cyflym yn cynnwys enghreifftiau i gopïo a gludo i brofi eich allwedd.

Llun o Adran Allwedd API

Webhooks a Logiau

Ychwanegwch webhooks (gwrandawyr ar ddigwyddiadau Legalesign), a gwirio eich logiau.

Llun o Adran Webhooks

2. Cais GET llwyddiannus

Y url gwreiddiol yw wastad: https://eu-api.legalesign.com/

Dechreuwch gyda cais GET i gadarnhau bod eich credydau’n gweithio. Newidiwch y defnyddiwr a’r cyfrinach 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
Node.js
Python
C#
Go

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

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

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

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

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, fe welwch eich grwpiau'n cael eu dychwelyd mewn JSON. Llwyddiant. 👏

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

cyngor

Bydd uri adnodd bob amser yn cael ei fformatio yn yr un modd. Ar gyfer PDF byddai'n '/api/v1/templatepdf/:pdfId/', ar gyfer dogfen anfonwyd bydd yn '/api/v1/document/:documentId/'. Sylwch sut mae pob URI yn gorffen mewn slas. Mae hynny hefyd yn wir am URLau eich galwadau API, maent i bob amser orffen â slas.

Os oedd y cais GET wedi methu, gwiriwch fod:

eich ApiKey wedi cael ei ffurfio'n gywir (yn dechrau gyda 'ApiKey),
bod gennych benawd Content-Type ar gyfer application/json, a
bod eich url yn gorffen gyda slas.

Gweler hefyd datrys problemau.

3. Llwytho dogfen i fyny trwy'r app gwe

I ddechrau, byddwn yn llwytho dogfen i fyny drwy'r app gwe a'i hanfon dannodd drwy'r API. Byddwn yn trafod sut i lwytho dogfen i fyny drwy'r API yn nes ymlaen.

Ewch i’r ap gwe a llwythwch eich dogfen i fyny. Ychwanegwch rôl llofnodydd sengl a llusgwch faes llofnod ar y ddogfen. Bydd tudalen y golygydd yn nodi a yw'r dogfen yn 'ddilys' (enghraifft o'w bod yn 'anniogel' fyddai os ychwanegwch rôl llofnodydd heb faes llofnod cysylltiedig).

Ar y golygydd ffurflen, copïwch yr ID hir alffaniwmerig o'r URL, dadgodwch base64 a thynnwch y tri llythyren gyntaf (sy'n 'tpl'). Y gweddill yw UUID sy'n eich ID chi.

Yn iaith REST API, yr uri adnodd ar gyfer y ddogfen hon yw /api/v1/templatepdf/UUID/.

Darllenwch ragor am IDs gwe a API.

Ein nomenclatau ni yw bod dogfen a lwythwyd i fyny yn 'dempled' ac wrth anfon un, rydych yn creu 'dogfen'.

cyngor

Os ydych am archifo templed pan anfonir y ddogfen, gosodwch 'archive_upon_send' fel prif brys yn y cais llwytho i fyny. Os nad ydych am i'r templed ymddangos o gwbl a'i ddileu ar ôl anfon, rhoi'r teitl '[deleted]' arno - bydd ein systemau glanhau yn ei ganfod a'i ddileu ar ôl diwrnod neu ddau. Gallwch hefyd sefydlu amseroedd cadw byr yn lefel y grŵp - dysgwch fwy.

4. Anfon dogfen am lofnodi

Nawr byddwn yn anfon hyn drwy’r API. Cofiwch ddefnyddio e-bost o’r e-byst 'cymeradwy' yn y sandbox. Defnyddiwch y tabiau isod i gael y cais yn iaith eich dewis.

cURL
Node.js
Python
C#
Go

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/

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

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

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

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 holl fyrddau sgwâr. Cyfeirlyfr API i anfon dogfen.

cyngor

Pan fyddwch yn ymweld â’r ddogfennaeth gyfeirio ar gyfer anfon dogfen edrychwch yn ofalus trwy’r holl briodweddau posibl. Fe welwch nifer ohonynt a fydd yn helpu gyda phroffesiynoldeb integreiddiad – tagiau i’ch cyfeiriadau a IDs eich hun (sydd yn dychwelyd i chi mewn webhooks), ailgyfeirio ar gyfer llofnodyddion, gosod testun arferol yn y pdf, a mwy.

Bydd galwad llwyddiannus yn dychwelyd cod statws 201. ✨

Cael ID dogfen a anfonwyd newydd

Y rhan bwysicaf o’r ymateb yw’r penawd lleoliad. Mae hwn yn cynnwys eich ID dogfen newydd.

cyngor

Defnyddiwch briodweddau 'tag' y ddogfen a ychwanegwch eich cyfeiriadau eich hun i wneud cysylltu â’ch cronfa ddata eich hun yn haws.

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

Mae'r URI 'status' yn dychwelyd set fer (a chyflym wrth ymholi) o briodweddau’r ddogfen.

I gael popeth o ddogfen defnyddiwch /api/v1/document/:documentId/.

gwybodaeth

Os nad yw cais yn llwyddiannus, fel arfer bydd CORFF yr ymateb yn cynnwys gwybodaeth am y gwall. Os na gewch statws llwyddiant, gwiriwch y CORFF am destun eglurhaol. Gweler hefyd datrys problemau.

Dysgwch fwy am alwad API Anfon Dogfennau.

5. Lawrlwytho'r ddogfen wedi'i llofnodi

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

cURL
Node.js
Python
C#
Go

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

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

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)

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

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

Cyfeirlyfr API Lawrlwytho PDF.

Mae’r PDF binari yn y corff o’r ymateb. Mae'r gorchymyn curl '-o' yn rhoi CORFF yr ymateb yn union yn faes.

Mae llawer o lyfrgelloedd REST neu HTTP yn trin gwrthrychau ymateb HTTP fel pe baent yn ffeiliau - felly dim ond cadwwch eich gwrthrych ymateb fel ffeil arferol.

cyngor

Defnyddiwch webhooks i gael hysbysiad o ddigwyddiad llofnodi a wedyn lawrlwythwch y ddogfen. Gweler webhooks.

6. Llwytho PDF i fyny

[Cliciwch yma i lawrlwytho PDF sampl wedi'i dagio gyda testun] (https://static.legalesign.com/tutorialQuickstartPdf.pdf), bydd mwy am feysydd ffurflen PDF yn dilyn.

Ar gyfer y galwad hon, troi eich PDF yn llinyn wedi'i amgodio base64. Nid yw hyn wedi ei wneud yn iawn yn y cynhyrchydd cod yn y ddogfennaeth. Yn lle hynny, copïwch y pseudocod hwn a bydd eich AI cyfeillgar yn ei drawsnewid i’ch iaith dewis:

$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']

Cyfeirlyfr API Llwytho PDF i fyny.

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

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

Bydd eich uri adnodd pdf yn edrych fel /api/v1/templatepdf/:pdfId/.

Anfon y PDF newydd

Yn ôl i’r cod gwnaethoch ei ddefnyddio i anfon eich dogfen gyntaf, a newid y gwerth templatepdf.

Gwnewch y cais eto a dyna ni, anfonwyd eich PDF allan ar gyfer llofnodi.

Cyn i chi ddechrau codio, darllenwch ymlaen i ddysgu mwy am feysydd PDF.

Beth am feysydd PDF?

Sut mae Legalesign yn gwybod lle mae angen i’r person lofnodi ar y PDF, neu rannau i’w newid wrth anfon? Ymateb yw bod ein PDF wedi cael ei baratoi ymlaen llaw gyda thagiau: rydym wedi rhoi tag testun Legalesign o fewn y PDF a sefydlwyd 'process_tags' i wir yn y cais llwytho PDF.

Lawrlwythwch PDF sampl wedi'i dagio gyda testun.

Mae tagiau testun yn testun wedi’i fformatio’n arbennig i’w roi mewn PDF. Bydd Legalesign yn dadansoddi’r testun yn eich ffeil, gan ddisodli’r tagiau gyda maes llofnod a ffurflen. Ar gyfer llofnodydd unigol yr unig beth sydd ei angen ydy ychwanegu: <<t=signature>>. Bydd Legalesign yn ei ganfod ac yn lleoli'r llofnod yno. Dysgwch am dagiau testun.

Mae tagiau testun yn gofyn am raddfa ddysgu ac arbrofi. Mae dulliau eraill wedi’u hamlinellu isod, ond byddwch yn cael y gallu llawn o system ffurflenni Legalesign gyda nhw. Defnyddiwch yr ap gwe i brofi tagiau. Cysylltwch â [chefnogaeth]https://support.legalesign.com) am gymorth ac enghreifftiau.

Dyma 4 dull arall o sefydlu meysydd:

1. Fersiwn hawsaf/cyflymaf. Sefydlwch eich PDF gan ddefnyddio'r app gwe Legalesign.

Ar ôl i chi lwytho PDF i fyny, byddwch yn mynd i’r rhyngwyneb golygydd lle gallwch lusgo a gollwng meysydd ffurflen.

Llusgwch a gollwng llofnod, yna nodwch yr ID codiedig yn gyfeiriad gwe. Bydd hyn yn edrych rhywbeth fel 'dHBsMTRlZTQ0ZWUtZGE0Ni0xMWVmLTllZmUtMDI5ZGQ0ODkzZGRk'.

Dadgodwch base64 yr ID hwn a gwelwch ei fod yn UUID â'r rhagddodiad 'tpl'. Y rhan UUID (tynnwch 'tpl') yw eich pdfID. Dysgwch ragor am IDs Legalesign.

Bydd eich URI API PDF resource yn - /api/v1/templatepdf/:pdfId/.

Rhowch hynny i briodwedd 'templatepdf' y galwad anfon dogfen.

gwybodaeth

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

2. Defnyddiwch gydlynydd x/y ar gyfer meysydd.

Y ffordd symlaf i ddechrau gyda chydlynydd x/y ydy gosod PDF yn yr ap gwe ac yna gwneud ymholiad API am y meysydd hynny (GET PDF Fields - /api/v1/templatepdf/:pdfId/fields/).

Bydd yr eitem JSON rydych yn ei gael yn ôl yn union yr un schema JSON y mae angen i chi ei ddefnyddio i greu meysydd hefyd.

Defnyddiwch ef fel templed. Addaswch unrhyw werthoedd a POSTiwch ef yn ôl i’r un penbont (gan addasu'r ID PDF yn briodol). Pwynt terfyn Creu Maes PDF.

3. Mewnosodwch ein tudalen golygu PDF. NEWYDD!

Defnyddiwch ein cydran olygwr i fewnosod ein golygydd PDF yn uniongyrchol yn eich ap eich hun. Dysgwch fwy am y cydran golygu dogfennau.

4. Meysydd Ffurflen PDF NEWYDD!

Os yw’ch PDF yn cynnwys meysydd Ffurflen PDF arferol, gall Legalesign eu mewnforio’n awtomatig.

Codio hapus!

Yn y tiwtorial hwn daethoch â chredydau API, gwnaethoch ymholi’n llwyddiannus am eich grŵp(iau), anfonwyd dogfen at ddefnyddwyr ar gyfer llofnodi gan ddefnyddio HTML a PDF, a llwythwyd dogfen llofnodi lawr.

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

cyngor

Da iawn, cyrhaeddoch y diwedd - diolch am ddarllen hyn. Ein cais olaf, a chyngor, yn seiliedig ar flynyddoedd o brofiad datblygwyr yn integreiddio gyda'r API hwn, ydy eich bod yn cymryd eiliad i ddarllen drwy’r holl briodweddau ar y pwynt terfyn creu dogfen (ac clicio drwyddo i weld beth sydd gan 'signers', 'pdftext' a 'signertext') - dyma’r galwad bwysicaf yn eich integreiddiad. Creu dogfen ar gyfer llofnodi.

Tiwtorial Dechrau Cyflym

Llyfrgelloedd cleient

1. Creu cyfrif

Gosodiadau API

Sandbox

Allwedd API

Webhooks a Logiau

2. Cais GET llwyddiannus

3. Llwytho dogfen i fyny trwy'r app gwe

4. Anfon dogfen am lofnodi

Cael ID dogfen a anfonwyd newydd

5. Lawrlwytho'r ddogfen wedi'i llofnodi

6. Llwytho PDF i fyny

Anfon y PDF newydd

Beth am feysydd PDF?

1. Fersiwn hawsaf/cyflymaf. Sefydlwch eich PDF gan ddefnyddio'r app gwe Legalesign.

2. Defnyddiwch gydlynydd x/y ar gyfer meysydd.

3. Mewnosodwch ein tudalen golygu PDF. NEWYDD!

4. Meysydd Ffurflen PDF NEWYDD!

Codio hapus!

Camau nesaf:

Export This Article

Llyfrgelloedd cleient​

1. Creu cyfrif​

Gosodiadau API​

Sandbox​

Allwedd API​

Webhooks a Logiau​

2. Cais GET llwyddiannus​

3. Llwytho dogfen i fyny trwy'r app gwe​

4. Anfon dogfen am lofnodi​

Cael ID dogfen a anfonwyd newydd​

5. Lawrlwytho'r ddogfen wedi'i llofnodi​

6. Llwytho PDF i fyny​

Anfon y PDF newydd​

Beth am feysydd PDF?​

1. Fersiwn hawsaf/cyflymaf. Sefydlwch eich PDF gan ddefnyddio'r app gwe Legalesign.​

2. Defnyddiwch gydlynydd x/y ar gyfer meysydd.​

3. Mewnosodwch ein tudalen golygu PDF. NEWYDD!​

4. Meysydd Ffurflen PDF NEWYDD!​

Codio hapus!​

Camau nesaf:​

Export This Article

Llyfrgelloedd cleient

1. Creu cyfrif

Gosodiadau API

Sandbox

Allwedd API

Webhooks a Logiau

2. Cais GET llwyddiannus

3. Llwytho dogfen i fyny trwy'r app gwe

4. Anfon dogfen am lofnodi

Cael ID dogfen a anfonwyd newydd

5. Lawrlwytho'r ddogfen wedi'i llofnodi

6. Llwytho PDF i fyny

Anfon y PDF newydd

Beth am feysydd PDF?

1. Fersiwn hawsaf/cyflymaf. Sefydlwch eich PDF gan ddefnyddio'r app gwe Legalesign.

2. Defnyddiwch gydlynydd x/y ar gyfer meysydd.

3. Mewnosodwch ein tudalen golygu PDF. NEWYDD!

4. Meysydd Ffurflen PDF NEWYDD!

Codio hapus!

Camau nesaf: