Ανέβασμα Αρχείου ως Πρότυπο
Αυτός ο οδηγός σας καθοδηγεί σε όλη τη διαδικασία δημιουργίας ενός προτύπου και ανέβασμα ενός αρχείου PDF, εικόνας ή Word για χρήση ως πρότυπο εγγράφου στο Legalesign.
Τι Θα Μάθετε
Μέχρι το τέλος αυτού του οδηγού, θα γνωρίζετε πώς να:
- Δημιουργήσετε ένα νέο πρότυπο στην ομάδα σας στο Legalesign
- Λάβετε το ID προτύπου και το URL ανέβασματος από την απόκριση της μετάλλαξης
- Ανέβασμα του αρχείου πηγής στο πρότυπο
- Επαληθεύσετε ότι το ανέβασμα ήταν επιτυχές
Προαπαιτούμενα
Πριν ξεκινήσετε, βεβαιωθείτε ότι έχετε:
- Λογαριασμό Legalesign με πρόσβαση API
- Τις διαπιστευτήριες αυθεντικοποίησής σας (δείτε τον οδηγό αυθεντικοποίησης)
- Ένα αρχείο PDF, εικόνας ή Word έτοιμο για ανέβασμα (μέγιστο 50MB)
- Το ID της ομάδας σας (τον χώρο εργασίας όπου θέλετε να δημιουργήσετε το πρότυπο)
Η Πλήρης Διαδικασία
Βήμα 1: Δημιουργία Προτύπου
Πρώτα, δημιουργήστε ένα κενό πρότυπο στο Legalesign. Αυτό επιστρέφει τόσο το ID του προτύπου όσο και ένα προ-υπογεγραμμένο URL ανέβασματος για το ανέβασμα του PDF. Για να το κάνετε αυτό, θα χρειαστεί να εκτελέσετε μια GraphQL μετάλλαξη. Εάν δεν το έχετε ξανακάνει, δείτε το Εισαγωγή στο GraphQL.
Τι είναι το Πρότυπο;
Ένα πρότυπο είναι μια επαναχρησιμοποιήσιμη δομή εγγράφου στο Legalesign. Μόλις ανεβάσετε ένα PDF σε ένα πρότυπο, μπορείτε να:
- Προσθέσετε πεδία υπογραφής και πεδία φόρμας
- Το στείλετε σε πολλούς παραλήπτες
- Το επαναχρησιμοποιήσετε για διαφορετικούς υπογράφοντες
GraphQL Μετάλλαξη
mutation CreateTemplate($input: templateCreateInput!) {
createTemplate(input: $input) {
id
uploadUrl
}
}
Είσοδοι Μεταβλητών
{
"input": {
"groupId": "grpYourGroupAPIId",
"title": "Employment Contract Template"
}
}
Επεξήγηση Παραμέτρων
- groupId: Το αναγνωριστικό σε base 64 της ομάδας/χώρου εργασίας σας (μπορείτε να το πάρετε από το URL στο Console https://console.legalesign.com/)
- title: Ένα περιγραφικό όνομα για το πρότυπό σας (μπορείτε να το αλλάξετε αργότερα)
- uploadOptions (προαιρετικό): Επιλογές επεξεργασίας που εφαρμόζονται όταν ανεβαίνει το PDF:
pdfFieldsImport: true— εισαγωγή ενσωματωμένων πεδίων φόρμας PDF ως πεδία προτύπουprocessTags: true— επεξεργασία ετικετών κειμένου Legalesign στο έγγραφο κατά το ανέβασμα
Βήμα 2: Εξαγωγή του ID Προτύπου και του URL Ανέβασματος
Η μετάλλαξη επιστρέφει ένα αντικείμενο templateCreateOutput. Αποθηκεύστε το πεδίο id και το string uploadUrl.
Παράδειγμα απόκρισης:
{
"data": {
"createTemplate": {
"id": "dHBsYjQ5YTg5NWQtYWRhMy0xMWYwLWIxZGMtMDY5NzZlZmU0MzIx",
"uploadUrl": "https://s3.amazonaws.com/bucket/path?signature=..."
}
}
}
Το ID προτύπου είναι ένα string κωδικοποιημένο σε Base64. Αποθηκεύστε και τις δύο τιμές της απόκρισης. Το uploadUrl έχει σύντομη διάρκεια ζωής και πρέπει να χρησιμοποιείται άμεσα.
Βήμα 3: Ανέβασμα του PDF σας
Χρησιμοποιήστε το επιστρεφόμενο uploadUrl για να ανεβάσετε απευθείας το PDF σας στο S3. Αυτό θα διαφέρει ανάλογα με το αναπτυξιακό περιβάλλον σας. Στο παράδειγμα με JavaScript χρησιμοποιήσαμε τη μέθοδο fetch, αλλά μπορείτε να χρησιμοποιήσετε και άλλες βιβλιοθήκες όπως το aws-amplify.
Πλήρη Παραδείγματα Εργασίας
- JavaScript
- Python
- C#
import fs from 'fs';
const AUTH_TOKEN = '<token-from-authentication-guide>';
const uploadPdfTemplate = async (groupId, title, pdfFilePath) => {
const graphqlEndpoint = 'https://graphql.uk.legalesign.com/graphql';
// Step 1: Create the template
console.log('Creating template...');
const createResponse = await fetch(graphqlEndpoint, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${AUTH_TOKEN}`
},
body: JSON.stringify({
query: `
mutation CreateTemplate($input: templateCreateInput!) {
createTemplate(input: $input) {
id
uploadUrl
}
}
`,
variables: {
input: {
groupId: groupId,
title: title
}
}
})
});
const createResult = await createResponse.json();
const templateId = createResult.data.createTemplate.id;
const uploadUrl = createResult.data.createTemplate.uploadUrl;
console.log('Template created with ID:', templateId);
// Step 2: Upload the PDF
console.log('Uploading PDF...');
const fileData = fs.readFileSync(pdfFilePath);
const uploadResponse = await fetch(uploadUrl, {
method: 'PUT',
body: fileData,
headers: {
'Content-Type': 'application/pdf'
}
});
if (!uploadResponse.ok) {
throw new Error(`Upload failed: ${uploadResponse.statusText}`);
}
console.log('PDF uploaded successfully!');
return {
success: true,
templateId: templateId,
title: title
};
};
// Usage example
uploadPdfTemplate(
'grpYourGroupId',
'Employment Contract',
'./contract.pdf'
).then(result => {
console.log('Complete!', result);
}).catch(error => {
console.error('Error:', error);
});
Δεν απαιτούνται επιπλέον εξαρτήσεις — το Node.js 18+ περιλαμβάνει το fetch εγγενώς.
import requests
from gql import gql, Client
from gql.transport.requests import RequestsHTTPTransport
def upload_pdf_template(graphql_endpoint, auth_token, group_id, title, pdf_file_path):
transport = RequestsHTTPTransport(
url=graphql_endpoint,
headers={'Authorization': auth_token}
)
client = Client(transport=transport, fetch_schema_from_transport=True)
# Step 1: Create the template
print('Creating template...')
create_mutation = gql('''
mutation CreateTemplate($input: templateCreateInput!) {
createTemplate(input: $input) {
id
uploadUrl
}
}
''')
create_result = client.execute(
create_mutation,
variable_values={
'input': {
'groupId': group_id,
'title': title
}
}
)
template_id = create_result['createTemplate']['id']
upload_url = create_result['createTemplate']['uploadUrl']
print(f'Template created with ID: {template_id}')
# Step 2: Upload the PDF
print('Uploading PDF...')
with open(pdf_file_path, 'rb') as f:
file_data = f.read()
response = requests.put(
upload_url,
data=file_data,
headers={'Content-Type': 'application/pdf'}
)
if response.status_code != 200:
raise Exception(f'Upload failed: {response.status_code}')
print('PDF uploaded successfully!')
return {
'success': True,
'templateId': template_id,
'title': title
}
if __name__ == '__main__':
result = upload_pdf_template(
'https://graphql.uk.legalesign.com/graphql',
'Bearer YOUR_TOKEN',
'grpYourGroupId',
'Employment Contract',
'./contract.pdf'
)
print('Complete!', result)
using System;
using System.IO;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using GraphQL;
using GraphQL.Client.Http;
using GraphQL.Client.Serializer.Newtonsoft;
using Newtonsoft.Json.Linq;
public class PdfTemplateUploader
{
private readonly GraphQLHttpClient graphQLClient;
public PdfTemplateUploader(string graphqlEndpoint, string authToken)
{
graphQLClient = new GraphQLHttpClient(graphqlEndpoint, new NewtonsoftJsonSerializer());
graphQLClient.HttpClient.DefaultRequestHeaders.Add("Authorization", authToken);
}
public async Task<UploadResult> UploadPdfTemplate(
string groupId,
string title,
string pdfFilePath)
{
// Step 1: Create the template
Console.WriteLine("Creating template...");
var createMutation = new GraphQLRequest
{
Query = @"
mutation CreateTemplate($input: templateCreateInput!) {
createTemplate(input: $input) {
id
uploadUrl
}
}
",
Variables = new
{
input = new
{
groupId = groupId,
title = title
}
}
};
var createResponse = await graphQLClient.SendMutationAsync<dynamic>(createMutation);
string templateId = createResponse.Data.createTemplate.id;
string uploadUrl = createResponse.Data.createTemplate.uploadUrl;
Console.WriteLine($"Template created with ID: {templateId}");
// Step 2: Upload the PDF
Console.WriteLine("Uploading PDF...");
using var httpClient = new HttpClient();
var fileBytes = await File.ReadAllBytesAsync(pdfFilePath);
var content = new ByteArrayContent(fileBytes);
content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/pdf");
var putResponse = await httpClient.PutAsync(uploadUrl, content);
if (!putResponse.IsSuccessStatusCode)
{
throw new Exception($"Upload failed: {putResponse.StatusCode}");
}
Console.WriteLine("PDF uploaded successfully!");
return new UploadResult
{
Success = true,
TemplateId = templateId,
Title = title
};
}
}
public class UploadResult
{
public bool Success { get; set; }
public string TemplateId { get; set; }
public string Title { get; set; }
}
class Program
{
static async Task Main(string[] args)
{
var uploader = new PdfTemplateUploader(
"https://graphql.uk.legalesign.com/graphql",
"Bearer YOUR_TOKEN"
);
var result = await uploader.UploadPdfTemplate(
"grpYourGroupId",
"Employment Contract",
"./contract.pdf"
);
Console.WriteLine($"Complete! Template ID: {result.TemplateId}");
}
}
Τι Συμβαίνει Μετά το Ανέβασμα;
Μόλις ανεβεί το PDF σας, το Legalesign αυτόματα:
- Σαρώει για ιούς - Εξασφαλίζει ότι το αρχείο είναι ασφαλές
- Επικυρώνει ή μετατρέπει το αρχείο - Ελέγχει αν τα PDFs είναι έγκυρα ή μετατρέπει υποστηριζόμενα αρχεία όπως έγγραφα Word και εικόνες σε PDF
- Εξάγει πληροφορίες σελίδων - Λαμβάνει αριθμό σελίδων και διαστάσεις
- Επεξεργάζεται το αρχείο - Βελτιστοποιεί για προβολή και υπογραφή
- Το αποθηκεύει με ασφάλεια - Μεταφέρει το σε μόνιμη αποθήκευση
Αυτή η διαδικασία συνήθως διαρκεί λίγα δευτερόλεπτα. Μόλις ολοκληρωθεί, το πρότυπό σας είναι έτοιμο για χρήση!
Παρακολούθηση Προόδου Ανέβασματος
Για να λάβετε ανατροφοδότηση σε πραγματικό χρόνο σχετικά με την επεξεργασία ανέβασματος (σαρωτικά, επικύρωση, ολοκλήρωση), χρησιμοποιήστε συνδρομές. Δείτε Παρακολούθηση Προόδου Ανέβασματος με Συνδρομές.
Εναλλακτικά, κάντε επανάληψη στο πεδίο fileUploaded του προτύπου μέχρι να επιστρέψει true:
query CheckUploadStatus($id: ID!) {
template(id: $id) {
id
fileUploaded
}
}
Προσθήκη Υπογραφών και Πεδίων
Αν θέλετε να αυτοματοποιήσετε συμμετέχοντες και τοποθέτηση πεδίων, μπορείτε να προετοιμάσετε το αρχείο πηγής πριν το ανέβασμα με μερικούς διαφορετικούς τρόπους:
- Ετικέτες κειμένου — Προσθέστε ετικέτες κειμένου Legalesign στο αρχικό έγγραφο ώστε να δημιουργούνται αυτόματα συμμετέχοντες, πεδία υπογραφής και πεδία φόρμας κατά την επεξεργασία. Περνάτε
uploadOptions: { processTags: true }στη μετάλλαξηcreateTemplateγια να το ενεργοποιήσετε. Δείτε την εξήγηση στο REST API στον οδηγό αρχικής εκκίνησης και την αναφορά στο endpoint Μετατροπή Ετικετών Κειμένου. - Ενσωματωμένα πεδία PDF — Εάν το PDF σας περιέχει ήδη ενσωματωμένα πεδία φόρμας, περάστε
uploadOptions: { pdfFieldsImport: true }στη μετάλλαξηcreateTemplateγια να τα εισαγάγετε αυτόματα ως πεδία προτύπου.
Επόμενα Βήματα
Τώρα που έχετε πρότυπο με PDF, μπορείτε να:
- Προσθέσετε πεδία υπογραφής - Χρησιμοποιήστε τη μετάλλαξη
createTemplateElementγια να προσθέσετε πεδία - Δημιουργήσετε ρόλους - Ορίστε ποιος θα υπογράψει το έγγραφο
- Στείλετε για υπογραφή - Χρησιμοποιήστε τη μετάλλαξη
sendγια να το στείλετε στους παραλήπτες
Συνήθη Προβλήματα και Λύσεις
Σφάλμα "No permission"
Επαληθεύστε ότι το ID της ομάδας σας είναι σωστό και είστε αυθεντικοποιημένοι με τον σωστό λογαριασμό.
Σφάλμα "File too large"
Συμπιέστε το PDF σας — το μέγιστο μέγεθος είναι 50MB.
Λήξη του URL Ανέβασματος
Χρησιμοποιήστε το uploadUrl που επιστράφηκε από τη createTemplate έγκαιρα. Εάν λήξει πριν το ανεβάσετε, ζητήστε νέο URL με το ερώτημα upload χρησιμοποιώντας το αποθηκευμένο ID προτύπου.
Σφάλμα "Invalid PDF"
Ανοίξτε το PDF σε πρόγραμμα ανάγνωσης PDF για να βεβαιωθείτε ότι είναι έγκυρο και στη συνέχεια экспорт ή αποθηκεύστε το εκ νέου.