Οδηγός Γρήγορης Εκκίνησης

Η πρόσβαση στο API απαιτεί έγκριση

Για να χρησιμοποιήσετε το Legalesign API πρέπει να επικοινωνήσετε μαζί μας για να λάβετε έγκριση για χρήση του API στον λογαριασμό σας.

συμβουλή

Χρησιμοποιείτε Cursor, Claude ή άλλο εργαλείο AI για κωδικοποίηση; Συνδέστε το με τα έγγραφα Legalesign για βοήθεια με επίγνωση συμφραζομένων καθώς ακολουθείτε αυτόν τον οδηγό.

Σε αυτόν τον οδηγό θα ολοκληρώσετε τα βασικά κλήσεις API που χρειάζονται οι περισσότεροι προγραμματιστές από μια ενσωμάτωση eSignature - ανέβασμα εγγράφου και αποστολή του για υπογραφή.

Το Legalesign API είναι επεκτάσιμο, πολύπλευρο και έχει δοκιμαστεί παραγωγικά στα συστήματα των πελατών μας για πολλά χρόνια. Μπορείτε να το χρησιμοποιήσετε για ένα απλό έγγραφο με έναν υπογράφοντα, ή να στείλετε έγγραφα για μαρτυρία ή εγκρίσεις, βελτιστοποιημένο για παρτίδες, με φόρμες και άλλα. Μπορείτε να ενσωματώσετε για έναν σκοπό ή να το ενσωματώσετε μέσα στο λογισμικό σας για τους πελάτες σας - δείτε ενσωματώσεις.

Το REST API εκτελεί τις περισσότερες λειτουργίες και είναι ο πιο εύκολος τρόπος να ξεκινήσετε. Αν χρειάζεστε περισσότερα δείτε το GraphQL interface. Το Legalesign είναι API first με GraphQL. Μπορείτε να χρησιμοποιήσετε όποιο προτιμάτε.

Θα ακολουθήσουμε αυτά τα βήματα:

Δημιουργία λογαριασμού + API Key (δείτε Πώς να πάρετε έγκριση για πρόσβαση API).
Επιβεβαίωση ότι τα διαπιστευτήρια λειτουργούν και λήψη του team ID σας.
Ανέβασμα εγγράφου μέσω της web εφαρμογής.
Αποστολή για υπογραφή μέσω του API.
Λήψη του εγγράφου μετά την υπογραφή.
Ανέβασμα εγγράφου μέσω API.

Το Legalesign REST API είναι εύκολο στη χρήση. Η τεχνική αναφορά περιλαμβάνει ένα επεξεργαστή κώδικα. Μπορείτε να κάνετε αιτήματα από την τεχνική αναφορά με το api key σας, αλλιώς απλώς αντιγράψτε και επικολλήστε κατευθείαν στον κώδικά σας.

Εικόνα Γεννήτριας Κώδικα Εικόνα 1: Ο Επεξεργαστής Κώδικα του REST API.

Βιβλιοθήκες πελατών

Ή για το GraphQL interface Node.js

συμβουλή

Συστήνουμε οι προγραμματιστές να συνεργάζονται απευθείας με το API παρά με τα SDKs. Για βοήθεια, υπάρχει γεννήτρια κώδικα cut-and-paste στην τεχνική προδιαγραφή, και το AI σας μπορεί γρήγορα να παράγει παραδείγματα χρησιμοποιώντας το OpenAPI spec. Γιατί; Το ίδιο το API έχει περισσότερη λειτουργικότητα από τα SDKs, τελικά θα θέλετε να γνωρίζετε τα endpoints που χρησιμοποιείτε ούτως ή άλλως, θα αποφύγετε έξοδα abstraction και εξαρτήσεις, και—βάσει της εμπειρίας μας- θα ολοκληρώσετε πιο γρήγορα επίσης.

1. Δημιουργία λογαριασμού

Πηγαίνετε στο legalesign sign up. Χρησιμοποιήστε ένα κανονικό email για να δημιουργήσετε τον λογαριασμό (μη χρησιμοποιήσετε Google), ομοσπονδιακές ταυτότητες όπως η Google δεν λειτουργούν για το API.

Θα σας ζητηθεί να δημιουργήσετε μια ομάδα. Οι ομάδες είναι τα δομικά στοιχεία του Legalesign. Όλη η επεξεργασία εγγράφων γίνεται μέσα σε μια ομάδα. Πρέπει να αναφέρεστε στην ομάδα σας στις περισσότερες κλήσεις API.

πληροφορίες

Μια 'ομάδα' ή μια 'ομάδα χρηστών' είναι το ίδιο. Στην web εφαρμογή μιλάμε για 'ομάδες', αλλά στο σχήμα του API αναφέρεται ως group.

Επικοινωνήστε με την υποστήριξη για ένα API Key. Πείτε μας τη χρήση σας, την εμπειρία σας στην ανάπτυξη API και μερικές λεπτομέρειες ώστε να επιβεβαιώσουμε ότι είστε πραγματικοί (π.χ. λεπτομέρειες του που εργάζεστε).

Ρυθμίσεις API

Μόλις πιστοποιηθείτε πηγαίνετε στην API Dashboard. Δημιουργήστε τα διαπιστευτήρια API σας στην ενότητα API Key.

Πάρτε λίγο χρόνο να εξετάσετε το Developer Portal.

Sandbox

Στην ενότητα Περιβάλλοντος θα δείτε ειδοποίηση αν βρίσκεστε σε sandbox ή σε παραγωγική λειτουργία.

Το Sandbox περιορίζει που μπορείτε να στείλετε τα έγγραφά σας. Θα δείτε μια φόρμα για να προσθέσετε μέχρι 5 εγκεκριμένα emails - προσθέστε μερικά τώρα.

Όταν η ενσωμάτωσή σας είναι έτοιμη: μετακινηθείτε σε λειτουργία παραγωγής.

συμβουλή

Δημιουργήστε μια δεύτερη ομάδα. Χρησιμοποιήστε την πρώτη ομάδα για ανάπτυξη και άλλες ομάδες για παραγωγή. Πείτε στην υποστήριξη το όνομα της ομάδας ανάπτυξής σας για να την εξαιρέσει από τη χρέωση.

API key

Στην ενότητα API Key θα δείτε τα στοιχεία των API keys σας. Θα σας δείχνεται μόνο το κλειδί όταν το δημιουργείτε.

Η ενότητα Quickstart περιέχει παραδείγματα cut and paste για να δοκιμάσετε το κλειδί σας.

Στιγμιότυπο οθόνης ενότητας API Key

Webhooks & Logs

Προσθέστε webhooks (τους ακροατές σας για τα γεγονότα Legalesign) και δείτε τα logs σας.

Στιγμιότυπο οθόνης ενότητας Webhooks

2. Επιτυχημένο αίτημα GET

Η βασική διεύθυνση είναι πάντα: https://eu-api.legalesign.com/

Ξεκινήστε με ένα αίτημα GET για να επιβεβαιώσετε ότι τα διαπιστευτήριά σας λειτουργούν. Αντικαταστήστε τις τιμές username και secret στο παρακάτω παράδειγμα.

Στα παραδείγματα χρησιμοποιείται curl, και μπορείτε να αλλάξετε ανάμεσα σε cURL, Node.js, Python, C# και Go χρησιμοποιώντας τις καρτέλες πιο κάτω.

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

Τεκμηρίωση API: GET group API reference.

Όταν εκτελέσετε το παραπάνω query, θα δείτε τις ομάδες σας σε μορφή JSON. Επιτυχία. 👏

Τα δεδομένα απάντησης περιέχουν το 'resource uri' για την ομάδα σας και μοιάζει με /api/v1/group/:groupId/. Κρατήστε το σημειωμένο, θα το χρειαστείτε στις περισσότερες κλήσεις API.

συμβουλή

Ένα resource uri θα έχει πάντα την ίδια μορφή. Για ένα PDF θα είναι '/api/v1/templatepdf/:pdfId/', για ένα αποσταλμένο έγγραφο θα είναι '/api/v1/document/:documentId/'. Σημειώστε πως όλα τα URIs τελειώνουν με το '/'. Το ίδιο ισχύει και για τα URLs των API κλήσεων σας, τελειώνετε πάντα με '/'.

Αν το αίτημα GET αποτύχει ελέγξτε ότι:

το ApiKey σας είναι σωστά μορφοποιημένο (ξεκινά με 'ApiKey'),
έχετε header Content-Type για application/json, και
το url σας τελειώνει με '/'

Δείτε επίσης αντιμετώπιση προβλημάτων.

3. Ανέβασμα εγγράφου μέσω της web εφαρμογής

Για να ξεκινήσουμε, θα ανεβάσουμε ένα έγγραφο μέσω της web εφαρμογής και θα το στείλουμε μέσω API. Θα καλύψουμε πως να ανεβάσετε ένα έγγραφο μέσω API αργότερα.

Πηγαίνετε στην web εφαρμογή και ανεβάστε το έγγραφό σας. Προσθέστε έναν μόνο ρόλο υπογράφοντα και σύρετε ένα πεδίο υπογραφής. Η σελίδα επεξεργασίας θα δείξει αν το έγγραφο είναι 'έγκυρο' (ένα παράδειγμα 'μη έγκυρου' μπορεί να είναι αν προσθέσετε ρόλο υπογράφοντα χωρίς πεδίο υπογραφής).

Στον επεξεργαστή φόρμας, αντιγράψτε το μακρύ αλφαριθμητικό ID από το URL, dekode-άρετέ το base64 και πετάξτε τα πρώτα 3 γράμματα (που θα πρέπει να είναι 'tpl'). Τα υπόλοιπα είναι ένα UUID που είναι το ID σας.

Με όρους REST API το resource uri για αυτό το έγγραφο είναι /api/v1/templatepdf/UUID/.

Μάθετε περισσότερα για web και API IDs.

Η ορολογία μας είναι ότι ένα ανεβασμένο έγγραφο είναι 'template' και όταν το στείλετε δημιουργείτε ένα 'document'.

συμβουλή

Αν θέλετε να αρχειοθετήσετε ένα πρότυπο όταν το έγγραφο αποστέλλεται, ορίστε 'archive_upon_send' ως χαρακτηριστικό στο αίτημα ανεβάσματος. Αν θέλετε το πρότυπο να μην εμφανίζεται ποτέ και να διαγράφεται μετά την αποστολή δώστε του τον τίτλο '[deleted]' - τα συστήματα καθαρισμού μας θα το ανιχνεύσουν και θα το διαγράψουν μετά από μια-δυο μέρες. Μπορείτε επίσης να ορίσετε σύντομους χρόνους διατήρησης στο επίπεδο ομάδας - μάθετε περισσότερα.

4. Αποστολή εγγράφου για υπογραφή

Τώρα θα στείλουμε αυτό μέσω API. Θυμηθείτε να χρησιμοποιήσετε ένα email από τα εγκεκριμένα emails του sandbox σας. Χρησιμοποιήστε τις καρτέλες πιο κάτω για να πάρετε το αίτημα στη γλώσσα που προτιμάτε.

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

Ενημερώστε όλα τα τετράγωνα αγκύλες. API αναφορά για αποστολή εγγράφου.

συμβουλή

Όταν επισκεφτείτε την τεκμηρίωση αναφοράς για αποστολή εγγράφου ρίξτε μια καλή ματιά σε όλα τα πιθανά χαρακτηριστικά. Θα δείτε πολλά που βοηθούν στις πρακτικές της ενσωμάτωσης - tags για τις δικές σας αναφορές και IDs (που επιστρέφονται σε webhooks), ανακατεύθυνση για υπογράφοντες, ορισμός προσαρμοσμένου κειμένου στο pdf, και άλλα.

Μια επιτυχημένη κλήση θα επιστρέψει κωδικό κατάστασης 201. ✨

Λάβετε το νέο ID του αποσταλμένου εγγράφου

Το σημαντικό μέρος της απάντησης είναι το header location. Αυτό περιέχει το νέο ID εγγράφου σας.

συμβουλή

Χρησιμοποιήστε τα χαρακτηριστικά 'tag' του εγγράφου και προσθέστε δικές σας αναφορές για να διευκολύνετε τη συσχέτιση με τη δική σας βάση δεδομένων.

Το header location θα μοιάζει με /api/v1/status/:documentId/.

Το URI 'status' επιστρέφει ένα σύντομο (και γρήγορο για query) σύνολο χαρακτηριστικών εγγράφου.

Για να ζητήσετε τα πάντα από ένα έγγραφο χρησιμοποιήστε /api/v1/document/:documentId/.

πληροφορίες

Αν ένα αίτημα δεν έχει επιτυχία, το ΣΩΜΑ της απάντησης συνήθως περιέχει πληροφορίες για το σφάλμα. Αν δεν λάβετε επιτυχία, ελέγξτε το ΣΩΜΑ για επεξηγηματικό κείμενο. Δείτε επίσης αντιμετώπιση προβλημάτων.

Μάθετε περισσότερα για την κλήση Send Document API.

5. Λήψη του υπογεγραμμένου εγγράφου

Με το ID του αποσταλμένου εγγράφου που λάβατε παραπάνω, κάντε αίτημα για λήψη PDF στη γλώσσα που προτιμάτε:

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

API Αναφορά λήψης PDF.

Το δυαδικό PDF υπάρχει στο σώμα της απάντησης. Η εντολή curl '-o' βάζει το ΣΩΜΑ της απάντησης απευθείας σε ένα αρχείο.

Πολλές βιβλιοθήκες REST ή HTTP συμπεριφέρονται στα αντικείμενα απάντησης HTTP σαν να ήταν αρχεία οπότε απλώς αποθηκεύστε το αντικείμενο απάντησής σας σαν κανονικό αρχείο.

συμβουλή

Χρησιμοποιήστε webhooks για να ενημερώνεστε για γεγονός υπογραφής και μετά να κατεβάζετε το έγγραφο. Δείτε webhooks.

6. Ανέβασμα PDF

Πατήστε εδώ για να κατεβάσετε ένα δείγμα PDF με ετικέτες κειμένου, περισσότερα για πεδία φόρμας PDF ακολουθούν.

Για αυτή την κλήση, μετατρέψτε το PDF σας σε κωδικοποιημένο base64 string. Αυτό δεν γίνεται σωστά μέσα στη γεννήτρια κώδικα της τεκμηρίωσης. Αντ’ αυτού αντιγράψτε αυτό το ψευδοκώδικα και το φιλικό σας AI θα το μετατρέψει στη γλώσσα που προτιμάτε:

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

API αναφορά ανεβάσματος PDF.

Όπως συνήθως, μια επιτυχημένη απάντηση POST θα επιστρέψει κατάσταση '201' και το νέο ID θα βρίσκεται στο header 'location' της απάντησης.

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

Το resource URI του pdf σας θα μοιάζει με /api/v1/templatepdf/:pdfId/.

Στείλτε το νέο PDF

Επιστρέψτε στον κώδικα που χρησιμοποιήσατε για να στείλετε το πρώτο σας έγγραφο και αντικαταστήστε την τιμή templatepdf.

Εκτελέστε ξανά το αίτημα και αυτό ήταν, στείλατε το PDF σας για υπογραφή.

Πριν ξεκινήσετε να κωδικοποιείτε, ωστόσο, διαβάστε παρακάτω για να μάθετε περισσότερα για τα πεδία PDF.

Τι γίνεται με τα πεδία PDF;

Πώς ξέρει το Legalesign που πρέπει να υπογράψει κάποιος στο PDF, ή ποιες περιοχές να αλλάξουν κατά την αποστολή; Η απάντηση είναι ότι το PDF μας προετοιμάστηκε με ετικέτες: βάζουμε μια ετικέτα κειμένου Legalesign μέσα στο PDF και ορίζουμε 'process_tags' σε true στο αίτημα ανεβάσματος PDF.

Κατεβάστε ένα δείγμα PDF με ετικέτες κειμένου.

Οι ετικέτες κειμένου είναι ειδικά μορφοποιημένο κείμενο για τοποθέτηση σε ένα PDF. Το Legalesign θα αναλύσει το κείμενο στο αρχείο σας, αντικαθιστώντας τις ετικέτες με πεδία υπογραφής και φόρμας. Για έναν υπογράφοντα το μόνο που χρειάζεται είναι να προσθέσετε: <<t=signature>>. Το Legalesign θα το αναγνωρίσει και θα εντοπίσει την υπογραφή εκεί. Μάθετε για τις ετικέτες κειμένου.

Οι ετικέτες κειμένου έχουν καμπύλη εκμάθησης και χρειάζονται δοκιμές και λάθη. Άλλες μέθοδοι αναφέρονται παρακάτω, όμως αποκτάτε πλήρη δυνατότητα του συστήματος φορμών Legalesign με αυτές. Χρησιμοποιήστε την web εφαρμογή για να δοκιμάσετε τις ετικέτες. Επικοινωνήστε με υποστήριξη για βοήθεια και παραδείγματα.

Εδώ είναι 4 άλλοι τρόποι να ρυθμίσετε πεδία:

1. Εύκολη/γρήγορη εκδοχή. Ρυθμίστε το PDF σας χρησιμοποιώντας την Legalesign web εφαρμογή.

Μετά το ανέβασμα PDF θα πάτε στην διεπαφή επεξεργαστή όπου μπορείτε να σύρετε και αποθέσετε πεδία φόρμας.

Σύρετε και αποθέστε μια υπογραφή, και μετά σημειώστε το κωδικοποιημένο ID στη διεύθυνση web. Αυτό θα μοιάζει με κάτι σαν 'dHBsMTRlZTQ0ZWUtZGE0Ni0xMWVmLTllZmUtMDI5ZGQ0ODkzZGRk'.

Δεκωδικοποιήστε αυτό το ID σε base64 και θα δείτε ότι είναι ένα UUID με πρόθεμα 'tpl'. Το μέρος UUID (αφαιρέστε το 'tpl') είναι το pdfID σας. Μάθετε περισσότερα για Legalesign IDs.

Το resource uri API PDF σας θα είναι - /api/v1/templatepdf/:pdfId/.

Τοποθετήστε αυτό στο χαρακτηριστικό 'templatepdf' της κλήσης αποστολής εγγράφου.

πληροφορίες

Αν σχεδιάζετε να στείλετε αυτό το PDF πάνω από μία φορά, βεβαιωθείτε ότι το 'Αυτόματο αρχειοθέτησης' είναι απενεργοποιημένο. Δείτε πώς

2. Χρησιμοποιήστε συντεταγμένες x/y για πεδία.

Ο πιο απλός τρόπος να ξεκινήσετε με συντεταγμένες x/y είναι να ρυθμίσετε ένα PDF στην web εφαρμογή και μετά να κάνετε query API για τα πεδία αυτά (GET PDF Fields - /api/v1/templatepdf/:pdfId/fields/).

Το αντικείμενο JSON που λαμβάνετε είναι το ακριβώς ίδιο σχήμα JSON που χρειάζεστε για να δημιουργήσετε πεδία.

Χρησιμοποιήστε το ως πρότυπο. Τροποποιήστε οποιεσδήποτε τιμές και κάντε POST πίσω στο ίδιο endpoint (τροποποιώντας το PDF ID αναλόγως). Δημιουργία πεδίου PDF endpoint.

3. Ενσωματώστε τη σελίδα επεξεργασίας PDF μας. ΝΕΟ!

Χρησιμοποιήστε το συστατικό του επεξεργαστή μας για να ενσωματώσετε τον επεξεργαστή PDF απευθείας στη δική σας εφαρμογή. Μάθετε περισσότερα για το Document editor component.

4. Πεδία φόρμας PDF ΝΕΟ!

Αν το PDF σας περιέχει κανονικά πεδία φόρμας PDF, το Legalesign μπορεί να τα εισαγάγει αυτόματα.

Καλή κωδικοποίηση!

Σε αυτόν τον οδηγό αποκτήσατε διαπιστευτήρια API, κάνατε επιτυχημένα ερώτημα για τις ομάδες σας, στείλατε ένα έγγραφο για υπογραφή χρησιμοποιώντας HTML και PDF, και κατεβάσατε υπογεγραμμένο έγγραφο.

Καλή κωδικοποίηση! Είμαστε εδώ για να βοηθήσουμε, επικοινωνήστε με υποστήριξη για οποιαδήποτε βοήθεια.

συμβουλή

Ωραία, φτάσατε στο τέλος - ευχαριστούμε που διαβάσατε. Η τελευταία μας παράκληση και συμβουλή, βάσει ετών εμπειρίας από προγραμματιστές που ενσωματώνουν με αυτό το API, είναι να αφιερώσετε λίγο χρόνο να διαβάσετε όλα τα χαρακτηριστικά στο endpoint δημιουργίας εγγράφου (και να δείτε τι περιέχουν τα 'signers', 'pdftext' και 'signertext') - είναι η πιο σημαντική κλήση στην ενσωμάτωσή σας. Δημιουργία εγγράφου υπογραφής.

Οδηγός Γρήγορης Εκκίνησης

Βιβλιοθήκες πελατών

1. Δημιουργία λογαριασμού

Ρυθμίσεις API

Sandbox

API key

Webhooks & Logs

2. Επιτυχημένο αίτημα GET

3. Ανέβασμα εγγράφου μέσω της web εφαρμογής

4. Αποστολή εγγράφου για υπογραφή

Λάβετε το νέο ID του αποσταλμένου εγγράφου

5. Λήψη του υπογεγραμμένου εγγράφου

6. Ανέβασμα PDF

Στείλτε το νέο PDF

Τι γίνεται με τα πεδία PDF;

1. Εύκολη/γρήγορη εκδοχή. Ρυθμίστε το PDF σας χρησιμοποιώντας την Legalesign web εφαρμογή.

2. Χρησιμοποιήστε συντεταγμένες x/y για πεδία.

3. Ενσωματώστε τη σελίδα επεξεργασίας PDF μας. ΝΕΟ!

4. Πεδία φόρμας PDF ΝΕΟ!

Καλή κωδικοποίηση!

Επόμενα βήματα:

Export This Article

Βιβλιοθήκες πελατών​

1. Δημιουργία λογαριασμού​

Ρυθμίσεις API​

Sandbox​

API key​

Webhooks & Logs​

2. Επιτυχημένο αίτημα GET​

3. Ανέβασμα εγγράφου μέσω της web εφαρμογής​

4. Αποστολή εγγράφου για υπογραφή​

Λάβετε το νέο ID του αποσταλμένου εγγράφου​

5. Λήψη του υπογεγραμμένου εγγράφου​

6. Ανέβασμα PDF​

Στείλτε το νέο PDF​

Τι γίνεται με τα πεδία PDF;​

1. Εύκολη/γρήγορη εκδοχή. Ρυθμίστε το PDF σας χρησιμοποιώντας την Legalesign web εφαρμογή.​

2. Χρησιμοποιήστε συντεταγμένες x/y για πεδία.​

3. Ενσωματώστε τη σελίδα επεξεργασίας PDF μας. ΝΕΟ!​

4. Πεδία φόρμας PDF ΝΕΟ!​

Καλή κωδικοποίηση!​

Επόμενα βήματα:​

Export This Article

Βιβλιοθήκες πελατών

1. Δημιουργία λογαριασμού

Ρυθμίσεις API

Sandbox

API key

Webhooks & Logs

2. Επιτυχημένο αίτημα GET

3. Ανέβασμα εγγράφου μέσω της web εφαρμογής

4. Αποστολή εγγράφου για υπογραφή

Λάβετε το νέο ID του αποσταλμένου εγγράφου

5. Λήψη του υπογεγραμμένου εγγράφου

6. Ανέβασμα PDF

Στείλτε το νέο PDF

Τι γίνεται με τα πεδία PDF;

1. Εύκολη/γρήγορη εκδοχή. Ρυθμίστε το PDF σας χρησιμοποιώντας την Legalesign web εφαρμογή.

2. Χρησιμοποιήστε συντεταγμένες x/y για πεδία.

3. Ενσωματώστε τη σελίδα επεξεργασίας PDF μας. ΝΕΟ!

4. Πεδία φόρμας PDF ΝΕΟ!

Καλή κωδικοποίηση!

Επόμενα βήματα: