Ενσωματώστε την ηλεκτρονική υπογραφή στο stack σας

Γρήγορη έναρξη

Τρία βήματα: δημιουργήστε ένα API key από τις ρυθμίσεις, κωδικοποιήστε το PDF σας σε base64, στείλτε. Η απάντηση περιέχει το `signUrl` που μπορείτε να μοιράσετε απευθείας στον παραλήπτη.

# 1. Upload the PDF (multipart) and capture the returned document id.
DOC_ID=$(curl -s -X POST https://certyneo.com/api/v1/documents \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -F "file=@contrat.pdf" | jq -r .id)

# 2. Create a DRAFT envelope referencing the uploaded document.
ENV_ID=$(curl -s -X POST https://certyneo.com/api/v1/envelopes \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d "{
    \"subject\": \"Contrat de prestation\",
    \"documentIds\": [\"$DOC_ID\"],
    \"recipients\": [
      { \"email\": \"client@example.com\", \"name\": \"Marie Dubois\", \"role\": \"SIGNER\" }
    ]
  }" | jq -r .id)

# 3. Dispatch the envelope — this sends the invitation email/SMS.
curl -X POST https://certyneo.com/api/v1/envelopes/$ENV_ID/send \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxx"

// Plain fetch, no SDK to install.
const auth = { Authorization: `Bearer ${process.env.CERTYNEO_API_KEY}` };

// 1. Upload the PDF (multipart).
const fd = new FormData();
fd.append("file", new Blob([pdfBuffer], { type: "application/pdf" }), "contrat.pdf");
const doc = await fetch("https://certyneo.com/api/v1/documents", {
  method: "POST", headers: auth, body: fd,
}).then((r) => r.json());

// 2. Create the DRAFT envelope.
const envelope = await fetch("https://certyneo.com/api/v1/envelopes", {
  method: "POST",
  headers: { ...auth, "Content-Type": "application/json" },
  body: JSON.stringify({
    subject: "Contrat de prestation",
    documentIds: [doc.id],
    recipients: [
      { email: "client@example.com", name: "Marie Dubois", role: "SIGNER" },
    ],
  }),
}).then((r) => r.json());

// 3. Dispatch — this triggers the invitation channel for every recipient.
await fetch(`https://certyneo.com/api/v1/envelopes/${envelope.id}/send`, {
  method: "POST", headers: auth,
});
console.log(envelope.id);

import os, requests

auth = {"Authorization": f"Bearer {os.environ['CERTYNEO_API_KEY']}"}

# 1. Upload the PDF (multipart).
with open("contrat.pdf", "rb") as f:
    doc = requests.post(
        "https://certyneo.com/api/v1/documents",
        headers=auth,
        files={"file": ("contrat.pdf", f, "application/pdf")},
    ).json()

# 2. Create the DRAFT envelope.
envelope = requests.post(
    "https://certyneo.com/api/v1/envelopes",
    headers={**auth, "Content-Type": "application/json"},
    json={
        "subject": "Contrat de prestation",
        "documentIds": [doc["id"]],
        "recipients": [
            {"email": "client@example.com", "name": "Marie Dubois", "role": "SIGNER"},
        ],
    },
).json()

# 3. Dispatch — this triggers the invitation channel for every recipient.
requests.post(
    f"https://certyneo.com/api/v1/envelopes/{envelope['id']}/send",
    headers=auth,
)
print(envelope["id"])

Δοκιμάστε το API από τα εργαλεία σας

Η συλλογή Postman και το φύλλο RapidAPI δημιουργούνται από την προδιαγραφή OpenAPI που τεκμηριώνει επίσης αυτή τη σελίδα. Οι τρεις παραμένουν λοιπόν ευθυγραμμισμένες με το πραγματικό API, ένα endpoint κάθε φορά, παρά να αποκλίνουν στην πρώτη προσθήκη.

Συλλογή Postman

Οι 25 αιτήματα ταξινομημένα κατά τομέα — φάκελοι, έγγραφα, πρότυπα, σφραγίδες, webhooks — με παράδειγμα σώματος και απάντησης για καθένα. Επικολλήστε το κλειδί σας στη μεταβλητή apiKey της συλλογής, στη συνέχεια εκτελέστε GET /health: δεν απαιτεί καμία πιστοποίηση και επιβεβαιώνει ότι η διαμόρφωσή σας είναι σωστή πριν από την πρώτη πιστοποιημένη κλήση.

Άνοιγμα στο Postman

Φύλλο RapidAPI

Ο ίδιος κατάλογος endpoints, δοκιμάσιμος απευθείας από το πρόγραμμα περιήγησης. Ο χώρος δοκιμών αναμένει δύο ξεχωριστές κεφαλίδες: το κλειδί RapidAPI που σας εκχωρεί η πλατφόρμα και το κλειδί Certyneo σας στο Authorization — το δεύτερο είναι αυτό που εξουσιοδοτεί πραγματικά την κλήση.

Προβολή στο RapidAPI

Διαθέσιμα Endpoints

Όλες οι δημόσιες διαδρομές: λογαριασμός, έγγραφα, φάκελοι, πρότυπα, webhooks, ηλεκτρονικές σφραγίδες, κλειδιά API και χρέωση. Όλες δέχονται Bearer token και επιστρέφουν JSON.

Προτεινόμενα πλαίσια

Ένα πρότυπο καταχωρεί μία φορά για πάντα το PDF, τους ρόλους και τη θέση των πεδίων υπογραφής, στη συνέχεια επαναχρησιμοποιείται σε κάθε αποστολή: περάστε το αναγνωριστικό του στο templateId αντί του documentIds, και τα τοποθετημένα πεδία αντιγράφονται στον δημιουργημένο φάκελο.

• • Τα πρότυπα δημιουργούνται από τον πίνακα ελέγχου (Πρότυπα → Νέο πρότυπο), όπου κατατίθεται το έγγραφο και στη συνέχεια τοποθετούνται τα πεδία με το ποντίκι — αυτό είναι ο απλούστερος τρόπος. Το API επιτρέπει επίσης να δημιουργηθούν με POST /api/v1/templates, παρέχοντας τα έγγραφα, τους ρόλους και τα πεδία· προσοχή, τα πεδία τοποθετούνται εκεί σε απόλυτες συντεταγμένες (σελίδα, x, y, πλάτος, ύψος), πρέπει λοιπόν να γνωρίζετε τη διάταξη του PDF.
• • Σε ένα λογαριασμό που δεν έχει ακόμη καταχωρήσει κανένα πρότυπο, το GET /api/v1/templates επιστρέφει μια κενή λίστα. Αυτή είναι η κανονική συμπεριφορά, όχι ένα ελάττωμα ταυτοποίησης.
• • Η λίστα περιέχει μόνο τα πρότυπα που ανήκουν στον χρήστη ιδιοκτήτη του κλειδιού API. Ένα πρότυπο που δημιουργήθηκε από έναν συνάδελφο δεν εμφανίζεται εκεί, ακόμη και εντός ενός κοινόχρηστου χώρου εργασίας: δημιουργήστε το κλειδί από τον λογαριασμό που κατέχει το πρότυπο.
• • templateId και documentIds αποκλείουν αλλήλως: στείλτε το ένα ή το άλλο, ποτέ και τα δύο ούτε κανένα από τα δύο.
• • Παρέχετε τουλάχιστον τόσους παραλήπτες SIGNER όσους ρόλους υπογραφής διαθέτει το πρότυπο, διαφορετικά η δημιουργία απορρίπτεται με 400. Το πεδίο signerCount που επιστρέφεται από τη λίστα υποδεικνύει τον αναμενόμενο αριθμό.
• • Το επίπεδο υπογραφής του προτύπου κληρονομείται από τον φάκελο, εκτός αν το αίτημα μεταδίδει ρητά signatureLevel.

# 1. Discover the templates saved on this account.
curl -s https://certyneo.com/api/v1/templates \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxx"

# {
#   "data": [
#     { "id": "cmdq7f4k80001s6y2h1xa9pl3", "name": "Contrat de prestation",
#       "signerCount": 2, "documentCount": 1, "signatureLevel": "SIMPLE" }
#   ],
#   "pagination": { "page": 1, "pageSize": 20, "total": 1, "pages": 1 }
# }
#
# An empty "data" array means no template exists on this account yet —
# create one from the dashboard, it is not an authentication problem.

# 2. Create the envelope FROM the template: no documentIds and no field
#    coordinates, both are carried by the template. Pass one SIGNER
#    recipient per signer role, in the template's role order.
curl -X POST https://certyneo.com/api/v1/envelopes \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Contrat de prestation",
    "templateId": "cmdq7f4k80001s6y2h1xa9pl3",
    "recipients": [
      { "email": "client@example.com", "name": "Marie Dubois", "role": "SIGNER" },
      { "email": "legal@example.com", "name": "Paul Martin", "role": "SIGNER" }
    ]
  }'

# 3. The envelope is DRAFT at this point — POST /envelopes/{id}/send
#    dispatches it, exactly as in the quick-start above.

Αποστολή εγγράφου: δύο αποδεκτές μορφές

POST /api/v1/documents δέχεται το αρχείο με δύο τρόπους, κατά επιλογή. Οι ίδιοι έλεγχοι εφαρμόζονται και στις δύο περιπτώσεις: επιτρεπόμενοι τύποι, όριο 50 Mo, επαλήθευση δυαδικής υπογραφής και ανάλυση κακόβουλου λογισμικού.

• • Σε multipart/form-data, με ένα τμήμα που ονομάζεται file. Αυτή είναι η κλασική μορφή, αυτή του curl -F και της πλειοψηφίας των βιβλιοθηκών.
• • Σε ακατέργαστο σώμα: τα byte του αρχείου αποτελούν το σώμα του αιτήματος και η κεφαλίδα Content-Type δίνει τον τύπο του (application/pdf για παράδειγμα). Χρήσιμο από ένα εργαλείο που μεταδίδει το περιεχόμενο όπως είναι, χωρίς να περιτυλίγει το αίτημα — αυτό κάνει ο σύνδεσμος Power Automate.
• • Σε ακατέργαστο σώμα, το όνομα του αρχείου δεν έχει θέση στο σώμα: υποδείξτε το μέσω της κεφαλίδας X-File-Name ή της παραμέτρου ?fileName=. Χωρίς αυτό, το έγγραφο ονομάζεται σύμφωνα με τον τύπο του.
• • Ένας μη υποστηριζόμενος τύπος απαντά 415 ονοματίζοντας τις δύο αποδεκτές μορφές, και ένα σώμα που ανακοινώνεται ως multipart αλλά δεν είναι αναγνώσιμο απαντά 400. Κανένα από τα δύο δεν είναι σφάλμα διακομιστή.

# a. multipart/form-data — the classic shape.
curl -X POST https://certyneo.com/api/v1/documents \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -F "file=@contrat.pdf;type=application/pdf"

# b. raw body — the file bytes ARE the body, typed by Content-Type.
#    The filename has nowhere to live in the body, so pass it as a header
#    (or ?fileName=). Without it the document is named after its type.
curl -X POST https://certyneo.com/api/v1/documents \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/pdf" \
  -H "X-File-Name: contrat.pdf" \
  --data-binary "@contrat.pdf"

# Both return the same 201 with the document id to pass as documentIds.

Τοποθέτηση των πεδίων ψηφιακής όρασης

Χωρίς πρότυπο, ένας φάκελος που δημιουργείται από documentIds δεν έχει κανένα προ-τοποθετημένο πεδίο: ο υπογράφων λαμβάνει το έγγραφο χωρίς θέση υπογραφής. Ο πίνακας fields, μεταδιδόμενος στην ίδια κλήση δημιουργίας, τοποθετεί κάθε πεδίο με ακρίβεια — είναι το ισοδύναμο, από την πλευρά του API, αυτού που ένα πρότυπο καταχωρεί μια φορά για πάντα.

• • Οι συντεταγμένες είναι σε σημεία PDF, αρχή στην πάνω αριστερή γωνία της σελίδας και άξονας Y προς τα κάτω (μια σελίδα A4 μετρά 595 × 842 σημεία). x και y ορίζουν την πάνω αριστερή γωνία του πεδίου, width και height το μέγεθός του.
• • pageNumber ξεκινά από 1, documentIndex ξεκινά από 0. Ένας αριθμός σελίδας πέρα από το έγγραφο δεν απορρίπτεται κατά τη δημιουργία: το πεδίο αγνοείται κατά την υπογραφή και δεν εμφανίζεται πουθενά — είναι το πρώτο πράγμα που πρέπει να ελέγξετε όταν λείπει ένα πεδίο από την κλήση.
• • recipientEmail πρέπει να αντιστοιχεί σε έναν από τους παραλήπτες του ίδιου αιτήματος, χωρίς διάκριση πεζών και κεφαλαίων. Διαφορετικά η δημιουργία αποτυγχάνει παραθέτοντας όλες τις λανθασμένες γραμμές, γεγονός που αποφεύγει να τις διορθώνετε μία προς μία.
• • fields και templateId αποκλείουν αλλήλως: ένα πρότυπο φέρει ήδη τη δική του διάταξη. Ο πίνακας fields χρησιμοποιείται επομένως μόνο με documentIds.
• • Αποδεκτοί τύποι: SIGNATURE, INITIALS, DATE_SIGNED, TEXT, CHECKBOX και RADIO_GROUP. required είναι true από προεπιλογή· placeholder και dateFormat είναι προαιρετικά, και options διατηρείται μόνο για RADIO_GROUP.
• • Ένας φάκελος δέχεται το πολύ 100 πεδία, 20 έγγραφα και 50 παραλήπτες — οι όρια του σχεδίου σας ενδέχεται να είναι χαμηλότερα.

# Ad-hoc envelope WITH pre-placed fields — no template involved.
# Coordinates are PDF points, origin TOP-LEFT of the page, +Y downwards
# (A4 = 595 x 842 pt). x / y are the field box's top-left corner.
#
# The last field is positioned by ANCHOR instead of by eye: the server
# locates "Signature du client" in the PDF and computes the spot. x / y
# stay required there — they are the fallback if the text is not found.
curl -X POST https://certyneo.com/api/v1/envelopes \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Contrat de prestation",
    "documentIds": ["cmdq7f4k80001s6y2h1xa9pl3"],
    "recipients": [
      { "email": "client@example.com", "name": "Marie Dubois", "role": "SIGNER" }
    ],
    "fields": [
      { "recipientEmail": "client@example.com", "documentIndex": 0,
        "pageNumber": 2, "fieldType": "SIGNATURE",
        "x": 90, "y": 640, "width": 180, "height": 44 },
      { "recipientEmail": "client@example.com", "documentIndex": 0,
        "pageNumber": 2, "fieldType": "DATE_SIGNED",
        "x": 320, "y": 640, "width": 140, "height": 30,
        "dateFormat": "DD/MM/YYYY" },
      { "recipientEmail": "client@example.com", "documentIndex": 0,
        "pageNumber": 2, "fieldType": "TEXT",
        "x": 90, "y": 700, "width": 200, "height": 30,
        "placeholder": "Fonction", "required": false },
      { "recipientEmail": "client@example.com", "documentIndex": 0,
        "pageNumber": 2, "fieldType": "SIGNATURE",
        "anchorText": "Signature du client", "anchorPlacement": "below",
        "anchorIndex": 0,
        "x": 90, "y": 640, "width": 180, "height": 44 }
    ]
  }'

# The envelope is DRAFT at this point — POST /envelopes/{id}/send
# dispatches it, exactly as in the quick-start above.

Επιβεβαίωση

Κάθε πρόσφατη ζήτηση είναι μεταξύ των API κλειδιών στον κεφάλαιο Authorization. Τα κλείδια δημιουργούνται από Συσχετισμές → Κλειδιά API και εμφανίζονται μόνο ποτέ μια φορά.

GET /api/v1/account/me HTTP/1.1Host: certyneo.com
Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxx

# 200 OK
{ "data": { "id": "usr_…", "email": "you@example.com", "plan": "BUSINESS", "environment": "live" } }

• • Format: sk_live_… σε διαστάσεις παραγωγής, sk_test_… για τη λίθινο. Κεφάλαιο: Authorization: Bearer <κλείδωμα>.
• • Επιτόκια: envelopes, documents, webhooks, seals - σε ανάγνωση (:read) ή γραφή (:write). Η γραφή περιλαμβάνει την ανάγνωση; Το επιτόκιο * δίνει όλα τα δικαιώματα.
• • Τα κλειδιά sk_test_ δημιουργούν πόρους σε sandbox, εξαιρούμενα από την ποσόστωση και τη χρέωση. Δεν αποστέλλεται πραγματικό email στον παραλήπτη, εκτός εάν η διεύθυνσή του ταιριάζει με το email του λογαριασμού αποστολής — χρήσιμο για να δοκιμάσετε ολόκληρη τη ροή στον εαυτό σας.
• • Σφάλματα: 401 άκυρο κλείδωμα, 403 παραβιάση επιτόκιου, 429 ύψος ταχύτητας ανεξέρχεται, 402 μήνικος κλήρος ορίζεται.

Τύπος παρουσιάσεων

Ενα γνώση πριν από τη συμπλήρωση του υποψήφιου: οι συγκεκριμένες εγχώριες είναι κατάλληλες σε αντικείμενο data, ενώ τα μόνιμα πόρους επιστρέφονται ξεχωριστά. Εισαγώντας response.data.data σε ένα μόνιμο πόρο, επιστρέφει undefined.

// GET /api/v1/envelopes
// Collections are WRAPPED in a "data" array.
{
  "data": [
    { "id": "env_abc123", "subject": "Contrat", "status": "SENT" }
  ]
}

// GET /api/v1/envelopes/{id}
// Single resources are returned FLAT — no "data" envelope.
{
  "id": "env_abc123",
  "subject": "Contrat",
  "status": "COMPLETED",
  "recipients": [ /* … */ ]
}