POST /v1/envelopes

{
  "template": "tpl_mutual_nda",
  "variables": {
    "client": { "name": "Acme Robotics" }
  },
  "recipients": [
    { "role": "client", "name": "Jane Doe",
      "email": "jane@acme.dev" }
  ],
  "delivery": "embedded"
}

201 env_8Gm2kQ4rT1 · sent → completed · sealed

Umowy na wejściu, podpisane na wyjściu.

Bona Fide to e-podpis w formie API. Zamień szablon i swoje dane w kopertę gotową do podpisu, pozwól ludziom podpisywać w Twoim produkcie lub na hostowanej stronie i otrzymaj zapieczętowany PDF, który każdy może zweryfikować.

Szybki start Dokumentacja API

Jak to wszystko się łączy

Szablony

Prześlij PDF (lub plik Word) i rozmieść pola albo napisz umowę w trybie Document. Zmienne są opisane przez JSON Schema, więc API waliduje Twoje dane, zanim cokolwiek zostanie wysłane. Opublikowane wersje są niezmienne.

Koperty

Jedno wywołanie POST /v1/envelopes renderuje szablon z Twoimi zmiennymi i rozpoczyna kierowanie do odbiorców według roli i kolejności. Przebiegi próbne, klucze idempotencji i deduplikacja po externalId są wbudowane.

Podpisywanie po Twojemu

Linki w wiadomościach e-mail, hostowana strona lub komponent webowy <bf-signing> (z nakładkami dla React i Vue) w Twojej własnej aplikacji – z krótkotrwałymi, jednorazowymi sesjami tworzonymi przez Twój backend.

Dowody, które każdy może sprawdzić

Każdy zakończony dokument otrzymuje znacznik czasu dokumentu PAdES od publicznego urzędu znacznika czasu, a jego odcisk trafia do drzewa Merkle, którego korzenie Bona Fide podpisuje kluczem Ed25519. Każdy może zweryfikować kopię bez zakładania konta.

Cykl życia w skrócie

Zaprojektuj szablon w panelu lub przez API, a następnie opublikuj wersję.
Wyślij kopertę: POST /v1/envelopes z identyfikatorem szablonu, Twoimi zmiennymi i jednym odbiorcą na każdą rolę.
Podpisz: odbiorcy dostają link e-mailem albo tworzysz sesję podpisywania i osadzasz ją (delivery: "embedded").
Zakończ: gdy podpisze ostatni odbiorca, otrzymujesz webhook envelope.completed ze wszystkimi wpisanymi wartościami.
Zapieczętuj: zapieczętowany PDF (z certyfikatem ukończenia) jest gotowy, gdy nadejdzie envelope.sealed.
Zweryfikuj: każdy może upuścić PDF na stronie weryfikacji lub wywołać publiczne API weryfikacji.

Co sprawia, że z API pracuje się przyjemnie

Błędy, na które można zareagować. Każdy błąd jest w formacie RFC 9457 problem+json; błędy walidacji zawierają JSON Pointer dla każdego problemu, np. /variables/client/email.
Bezpieczne ponawianie. Wyślij Idempotency-Key z żądaniami POST, a ponowienie odtworzy pierwszą odpowiedź.
Darmowy, nieograniczony tryb testowy. Klucze bf_test_ tworzą koperty ze znakiem wodnym, za które nigdy nie płacisz. Zobacz Uwierzytelnianie.
Webhooki zgodne ze standardem. Dostarczenia są podpisywane zgodnie ze specyfikacją Standard Webhooks, ponawiane przez trzy dni i można je odtworzyć ponownie.
OpenAPI 3.1 generowane z kodu. Dokumentacja oraz pliki do pobrania openapi.json / openapi.yaml powstają z tych samych kontraktów zod, którymi API waliduje żądania.

Dalsze kroki

Szybki startKlucz API, koperta z szablonu, podpisywanie i webhook o zakończeniu w dziesięć minut.

PojęciaSzablony, role, pola, koperty, odbiorcy, sesje i organizacje.

Osadzone podpisywanieUmieść podpisywanie w swoim produkcie za pomocą .

WeryfikacjaJak działa pieczętowanie i kotwiczenie oraz jak samodzielnie sprawdzić dokument.

API jest dostępne pod adresem https://api.bonafidesign.com. Wszystkie ścieżki w tej dokumentacji są względne wobec niego.