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

Hợp đồng vào, đã ký ra.

Bona Fide là chữ ký điện tử dưới dạng API. Biến một mẫu và dữ liệu của bạn thành phong bì sẵn sàng để ký, để mọi người ký ngay trong sản phẩm của bạn hoặc trên trang được lưu trữ sẵn, và nhận một tệp PDF đã niêm phong mà bất kỳ ai cũng có thể xác minh.

Bắt đầu nhanh Tài liệu tham khảo API

Các thành phần kết hợp với nhau như thế nào

Mẫu

Tải lên một tệp PDF (hoặc tệp Word) và đặt các trường, hoặc soạn hợp đồng ở chế độ Document. Biến là một JSON Schema, nên API kiểm tra dữ liệu của bạn trước khi gửi bất cứ thứ gì. Phiên bản không thể thay đổi sau khi đã xuất bản.

Phong bì

Chỉ một lệnh POST /v1/envelopes là kết xuất mẫu với các biến của bạn và bắt đầu chuyển đến người nhận theo vai trò và thứ tự. Chạy thử, khóa lũy đẳng và chống trùng lặp theo externalId đều có sẵn.

Ký theo cách của bạn

Liên kết qua email, trang được lưu trữ sẵn, hoặc web component <bf-signing> (có bản bao cho React và Vue) ngay trong ứng dụng của bạn, với các phiên ngắn hạn, dùng một lần do backend của bạn tạo.

Bằng chứng ai cũng kiểm tra được

Mọi tài liệu đã hoàn tất đều nhận dấu thời gian tài liệu PAdES từ một tổ chức cấp dấu thời gian công khai, và dấu vân tay của tài liệu được đưa vào một cây Merkle mà Bona Fide ký các gốc bằng Ed25519. Bất kỳ ai cũng có thể xác minh một bản sao, không cần tài khoản.

Toàn bộ vòng đời trong một hình

Thiết kế một mẫu trong bảng điều khiển hoặc qua API, rồi xuất bản một phiên bản.
Gửi một phong bì: POST /v1/envelopes với id của mẫu, các biến của bạn và một người nhận cho mỗi vai trò.
Ký: người nhận nhận được liên kết qua email, hoặc bạn tạo một phiên ký và nhúng nó (delivery: "embedded").
Hoàn tất: khi người nhận cuối cùng ký, bạn nhận được webhook envelope.completed kèm mọi giá trị đã nhập.
Niêm phong: tệp PDF đã niêm phong (kèm chứng nhận hoàn tất) sẵn sàng khi envelope.sealed đến.
Xác minh: bất kỳ ai cũng có thể thả tệp PDF vào trang xác minh hoặc gọi API xác minh công khai.

Điều gì khiến API dễ dùng

Lỗi có thể xử lý được. Mọi lỗi đều là RFC 9457 problem+json; lỗi xác thực dữ liệu kèm một JSON Pointer cho từng vấn đề, chẳng hạn /variables/client/email.
Thử lại an toàn. Gửi Idempotency-Key cùng các yêu cầu POST, khi thử lại bạn sẽ nhận lại phản hồi đầu tiên.
Chế độ thử nghiệm miễn phí, không giới hạn. Khóa bf_test_ tạo phong bì có hình mờ và không bao giờ bị tính phí. Xem Xác thực.
Webhook theo một tiêu chuẩn. Các lần gửi được ký theo Standard Webhooks, được thử lại trong ba ngày và có thể phát lại.
OpenAPI 3.1, được tạo từ mã nguồn. Tài liệu tham khảo cùng các tệp có thể tải xuống openapi.json / openapi.yaml được tạo từ chính các hợp đồng zod mà API dùng để xác thực dữ liệu.

Bước tiếp theo

Bắt đầu nhanhKhóa API, phong bì từ mẫu, ký và webhook hoàn tất trong mười phút.

Khái niệmMẫu, vai trò, trường, phong bì, người nhận, phiên và tổ chức.

Ký nhúngĐưa trải nghiệm ký vào trong sản phẩm của bạn với .

Xác minhCách niêm phong và neo hoạt động, và cách tự kiểm tra một tài liệu.

API nằm tại https://api.bonafidesign.com. Mọi đường dẫn trong tài liệu này đều tương đối so với địa chỉ đó.