Integrer elektronisk signering i din stack

Hurtig start

Tre trin: opret en API-nøgle fra indstillingerne, kodér din PDF i base64, send. Svaret indeholder `signUrl`, som du direkte kan dele med modtageren.

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

Prøv API'en fra dine værktøjer

Postman-samlingen og RapidAPI-arket genereres fra OpenAPI-specifikationen, som også dokumenterer denne side. De tre forbliver således justeret på det rigtige API, endpoint for endpoint, snarere end at divergere ved første tilføjelse.

Postman-samling

De 25 anmodninger organiseret efter domæne — konvolutter, dokumenter, skabeloner, segl, webhooks — med et eksempel på brødtekst og svar for hver enkelt. Indsæt din nøgle i samlingens apiKey-variabel, og kør derefter GET /health: den kræver ingen godkendelse og bekræfter, at din konfiguration er god før det første godkendte opkald.

Åbn i Postman

RapidAPI-ark

Det samme katalog over endpoints, som kan testes direkte fra browseren. Testbænken forventer to forskellige headers: RapidAPI-nøglen, som platformen tildeler dig, og din Certyneo-nøgle i Authorization — det er sidstnævnte, der faktisk autoriserer opkaldet.

Se på RapidAPI

Tilgængelige endpoints

Alle offentlige ruter: konto, dokumenter, konvolutter, skabeloner, webhooks, elektroniske segl, API-nøgler og fakturering. Alle accepterer et Bearer-token og returnerer JSON.

Modeller af udstyr

En skabelon registrerer én gang for alle PDF'en, rollerne og placeringen af underskriftfelter, som derefter genbruges ved hver afsendelse: overfør dens identifikator i templateId i stedet for documentIds, og de positionerede felter kopieres til den oprettede kuvert.

• • Skabeloner oprettes fra dashboardet (Skabeloner → Ny skabelon), hvor du uploader dokumentet og positionerer felterne med musen — dette er den enkleste vej. API'en giver også mulighed for at oprette dem via POST /api/v1/templates ved at angive dokumenterne, rollerne og felterne; vær opmærksom på, at felterne her er positioneret i absolutte koordinater (side, x, y, bredde, højde), så du skal kende PDF'ens layout.
• • På en konto, der endnu ikke har registreret nogen skabelon, returnerer GET /api/v1/templates en tom liste. Dette er den normale adfærd, ikke en autentificeringsfejl.
• • Listen indeholder kun skabeloner, der ejes af brugeren, der ejer API-nøglen. En skabelon, der er oprettet af en kollega, vises ikke, selv inden for et delt arbejdsområde: generer nøglen fra kontoen, der ejer skabelonen.
• • templateId og documentIds udelukker hinanden: send den ene eller den anden, aldrig begge eller ingen af dem.
• • Angiv mindst lige så mange SIGNER-modtagere, som skabelonen har underskriftsroller, ellers afvises oprettelsen med 400. Feltet signerCount returneret af listen angiver det forventede antal.
• • Signaturens niveau på skabelonen arves af kuverten, medmindre anmodningen eksplicit sender 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.

Dokumentafsendelse: to formularer accepteret

POST /api/v1/documents accepterer filen på to måder efter eget valg. De samme kontroller gælder i begge tilfælde: autoriserede typer, grænse på 50 MB, verifikation af binær signatur og antivirusanalyse.

• • I multipart/form-data med en del kaldet file. Det er den klassiske form, den som curl -F og de fleste biblioteker bruger.
• • I råt krop: filens bytes udgør anmodningskroppen, og headeren Content-Type angiver dens type (for eksempel application/pdf). Nyttigt fra et værktøj, der videresender indholdet direkte, uden at pakke anmodningen ind — det er hvad Power Automate-forbindelsen gør.
• • I råt krop har filnavnet ingen plads i kroppen: angiv det via headeren X-File-Name eller parameteren ?fileName=. Uden den navngives dokumentet efter dets type.
• • En ikke-understøttet type svarer 415 ved at navngive de to accepterede formularer, og en krop annonceret som multipart, men ulæselig, svarer 400. Ingen af dem er en serverfejl.

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

Placering af signaturfelter

Uden en skabelon har en kuvert, der er oprettet fra documentIds, ingen forudpositionerede felter: underskriveren modtager dokumentet uden et sted at underskrive. Arrayet fields, der sendes i det samme opkald til oprettelse, placerer hvert felt med præcision — det svarer på API-siden til, hvad en skabelon engang for alle registrerer.

• • Koordinaterne er i PDF-punkter, oprindelsen i øverste venstre hjørne af siden, og Y-aksen peger nedad (en A4-side måler 595 × 842 punkter). x og y angiver feltets øverste venstre hjørne, width og height dets størrelse.
• • pageNumber starter ved 1, documentIndex starter ved 0. Et sidetal udover dokumentet afvises ikke ved oprettelse: feltet ignoreres ved underskrivelse og vises ingen steder — det er det første, man skal kontrollere, når et felt mangler i opkaldet.
• • recipientEmail skal svare til en af modtagerne i det samme opkald uden forskel på store og små bogstaver. Ellers mislykkes oprettelsen ved at angive alle de fejlagtige linjer, hvilket undgår at korrigere dem en ad gangen.
• • fields og templateId udelukker hinanden: en skabelon har allerede sit eget layout. Arrayet fields bruges derfor kun med documentIds.
• • Accepterede typer: SIGNATURE, INITIALS, DATE_SIGNED, TEXT, CHECKBOX og RADIO_GROUP. required er true som standard; placeholder og dateFormat er valgfri, og options ignoreres kun for RADIO_GROUP.
• • En kuvert accepterer maksimalt 100 felter, 20 dokumenter og 50 modtagere — grænserne for din plan kan være lavere.

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

Autentisering

Hvert kald har en API-nøgle i hovedet Authorization. Nøglerne genereres fra Indstillinger → API-nøgler og vises kun én gang.

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_… i produktion, sk_test_… for sandbox. Hovedet: Authorization: Bearer <nøgle>.
• • Omfang: envelopes, documents, webhooks, seals — læsning (:read) eller skrivning (:write). Skrivning implikerer læsning; omfang * giver alle rettigheder.
• • Nøglerne sk_test_ opretter ressourcer i sandbox, udelukket fra kvote og fakturering. Der sendes ingen rigtig e-mail til modtageren, medmindre adressen matcher den afsendende kontos e-mail — nyttigt til at teste hele flowet på dig selv.
• • Fejl: 401 ugyldig nøgle, 403 manglende rettigheder, 429 forhøjet belastning, 402 månedlig kvote nået.

Formen af svar

En ting at vide før du skriver din kunde: samlingerne er indkapslet i et data-objekt, mens enkelte ressourcer returneres flat. Læs response.data.data på en enkeltresurs returnerer derfor 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": [ /* … */ ]
}