Integrujte elektronický podpis do svého stacku

Rychlý start

Tři kroky : vytvořte klíč API z nastavení, zakódujte PDF v base64, odešlete. Odpověď obsahuje `signUrl`, který můžete sdílet přímo s příjemcem.

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

Vyzkoušejte API ze svých nástrojů

Kolekce Postman a list RapidAPI jsou generovány ze specifikace OpenAPI, která také dokumentuje tuto stránku. Všechny tři zůstávají v souladu s reálným API, endpoint po endpointu, místo aby se rozcházely při prvním přidání.

Kolekce Postman

25 požadavků seřazených podle domény — obálky, dokumenty, šablony, pečetě, webhooky — s příkladem textu a odpovědi pro každý. Vložte svůj klíč do proměnné apiKey kolekce a spusťte GET /health: nevyžaduje žádné ověření a potvrdí, že je vaše konfigurace správná před prvním ověřeným voláním.

Otevřít v Postmanu

List RapidAPI

Stejný katalog endpointů, testovatelný přímo z prohlížeče. Testovací prostředí očekává dva odlišné záhlaví: klíč RapidAPI, který vám platforma přidělila, a váš klíč Certyneo v Authorization — druhý skutečně autorizuje volání.

Zobrazit na RapidAPI

Dostupné endpointy

Všechny veřejné trasy: účet, dokumenty, obálky, šablony, webové háčky, elektronické pečetě, klíče API a fakturace. Všechny přijímají token Bearer a vrací JSON.

Šablony obálky

Šablona zaznamenává jednou provždy PDF, role a umístění podpisových polí, pak se opakovaně používá při každém odeslání: předejte její identifikátor v templateId místo documentIds a umístěná pole jsou zkopírována do vytvořené obálky.

• • Šablony se vytváří z ovládacího panelu (Šablony → Nová šablona), kde umístíte dokument a poté umístíte pole myší — to je nejjednodušší způsob. API umožňuje je také vytvářet pomocí POST /api/v1/templates poskytnutím dokumentů, rolí a polí; pozor, pole jsou v něm umístěna v absolutních souřadnicích (stránka, x, y, šířka, výška), takže musíte znát rozvržení PDF.
• • Na účtu, který dosud neregistroval žádnou šablonu, GET /api/v1/templates vrátí prázdný seznam. Toto je normální chování, nikoli selhání ověřování.
• • Seznam obsahuje pouze šablony patřící uživateli vlastnícímu klíč API. Šablona vytvořená kolegou se zde neobjevuje, ani v rámci sdíleného pracovního prostoru: vygenerujte klíč z účtu, který šablonu vlastní.
• • templateId a documentIds se vzájemně vylučují: odešlete jeden nebo druhý, nikdy oba ani žádný.
• • Poskytněte alespoň tolik příjemců SIGNER, kolik má šablona rolí podepisujících, jinak je vytváření odmítnuto s kódem 400. Pole signerCount vrácené seznamem označuje očekávaný počet.
• • Úroveň podpisu šablony je dědí obálka, pokud požadavek výslovně neprojde 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.

Odeslání dokumentu: dvě přijaté formy

POST /api/v1/documents přijímá soubor dvěma způsoby, podle výběru. Ve obou případech se vztahují stejné kontroly: povolené typy, limit 50 MB, ověření binárního podpisu a antivirová analýza.

• • V multipart/form-data s částí pojmenovanou file. Toto je klasická forma, forma curl -F a většiny knihoven.
• • V nezpracovaném těle: bajty souboru tvoří tělo požadavku a hlavička Content-Type určuje jeho typ (například application/pdf). Užitečné z nástroje, který přenáší obsah tak, jak je, bez zabalení požadavku — to dělá konektor Power Automate.
• • V nezpracovaném těle nemá název souboru místo v těle: uveďte jej prostřednictvím hlavičky X-File-Name nebo parametru ?fileName=. Bez něj je dokument pojmenován podle svého typu.
• • Nepodporovaný typ reaguje 415 a pojmenuje dvě přijaté formy a tělo oznámené jako multipart, které je nečitelné, reaguje 400. Ani jedno není chyba serveru.

# 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.

Umístění polí pro podpis

Bez šablony se obálka vytvořená z documentIds nemá žádné předem umístěné pole: podepisující obdrží dokument bez místa pro podpis. Pole array fields, předané ve stejném volání vytvoření, umístí každé pole na přesný bod — je to ekvivalent na straně API toho, co šablona zaznamenává jednou provždy.

• • Souřadnice jsou v bodech PDF, počátek v levém horním rohu stránky a osa Y směřuje dolů (stránka A4 měří 595 × 842 bodů). x a y označují levý horní roh pole, width a height jeho velikost.
• • pageNumber začíná na 1, documentIndex začíná na 0. Číslo stránky mimo dokument není při vytváření zamítnuto: pole je ignorováno v době podpisu a nikde se neobjevuje — je to první věc, kterou je třeba zkontrolovat, když pole chybí ve volání.
• • recipientEmail musí odpovídat jednomu z příjemců stejného volání bez rozlišení velikosti písmen. Jinak vytvoření selže vypsáním všech chybných řádků, což se vyhne jejich opravě jeden po druhém.
• • fields a templateId se vzájemně vylučují: šablona již nese svůj vlastní rozvržení. Pole fields se tedy používá pouze s documentIds.
• • Přijaté typy: SIGNATURE, INITIALS, DATE_SIGNED, TEXT, CHECKBOX a RADIO_GROUP. required má ve výchozím nastavení hodnotu true; placeholder a dateFormat jsou volitelné a options se bere v úvahu pouze pro RADIO_GROUP.
• • Obálka přijímá maximálně 100 polí, 20 dokumentů a 50 příjemců — limity vašeho plánu mohou být nižší.

# 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.

Ověřování

Každý volání obsahuje klíč API v hlavičce Authorization. Klíče se generují z Nastavení → Klíče API a ukazují se pouze jednou.

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

• • Formát: sk_live_… ve produkci, sk_test_… pro testovací prostředí. Hlavička: Authorization: Bearer <klíč>.
• • Obory: obálky, dokumenty, webhooky, značky — čtení (:read) nebo zápis (:write). Zápis implikuje čtení; obor * dává všechna práva.
• • Klíče sk_test_ vytvářejí testovací zdroje, které jsou vyloučeny z kvóty a fakturace. Příjemci se neodesílá žádný skutečný e-mail, pokud jeho adresa neodpovídá e-mailu odesílajícího účtu — užitečné pro otestování celého procesu na sobě.
• • Chyby: 401 neplatný klíč, 403 nedostatečná obor, 429 překročená rychlostová omezení, 402 měsíční kvota dosažena.

Forma odpovědí

Před tím, než zapišete svého klienta, je důležité znát: kolekce jsou obaleny v objektu data, zatímco jednotlivé zdroje jsou vráceny rovnou. Tedy čtení response.data.data na jednotlivém zdroji vrací tedy 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": [ /* … */ ]
}