Siirry sisältöön
bona fidedocs

Sopimukset sisään, allekirjoitettuina ulos.

Bona Fide on sähköinen allekirjoitus API:na. Tee mallista ja datastasi allekirjoitusvalmis kirjekuori, anna ihmisten allekirjoittaa tuotteessasi tai isännöidyllä sivulla ja vastaanota sinetöity PDF, jonka kuka tahansa voi tarkistaa.
PikaopasAPI-viite

Miten osat sopivat yhteen

Osio nimeltä “Miten osat sopivat yhteen”

Mallit

Lataa PDF (tai Word-tiedosto) ja sijoita kentät tai kirjoita sopimus asiakirjatilassa. Muuttujat ovat JSON Schema, joten API validoi datasi ennen kuin mitään lähetetään. Versioita ei voi muuttaa julkaisun jälkeen.

Kirjekuoret

Yksi POST /v1/envelopes renderöi mallin muuttujillasi ja aloittaa reitityksen vastaanottajille roolin ja järjestyksen mukaan. Kuiva-ajot, idempotenssiavaimet ja externalId-pohjainen kaksoiskappaleiden esto ovat valmiina.

Allekirjoitus haluamallasi tavalla

Sähköpostilinkit, isännöity sivu tai <bf-signing>-verkkokomponentti (React- ja Vue-kääreineen) omassa sovelluksessasi, lyhytikäisillä ja kertakäyttöisillä istunnoilla, jotka taustajärjestelmäsi luo.

Todisteet, jotka kuka tahansa voi tarkistaa

Jokainen valmis asiakirja saa PAdES-asiakirja-aikaleiman julkiselta aikaleimapalvelulta, ja sen sormenjälki lisätään Merkle-puuhun, jonka juuret Bona Fide allekirjoittaa Ed25519:llä. Kuka tahansa voi tarkistaa kopion ilman tiliä.

Elinkaari yhdellä silmäyksellä

Osio nimeltä “Elinkaari yhdellä silmäyksellä”
  1. Suunnittele malli hallintapaneelissa tai API:n kautta ja julkaise sitten versio.
  2. Lähetä kirjekuori: POST /v1/envelopes mallin tunnuksella, muuttujillasi ja yhdellä vastaanottajalla roolia kohden.
  3. Allekirjoita: vastaanottajat saavat linkin sähköpostitse, tai luot allekirjoitusistunnon ja upotat sen (delivery: "embedded").
  4. Viimeistele: kun viimeinen vastaanottaja allekirjoittaa, saat envelope.completed-webhookin, jossa ovat kaikki syötetyt arvot.
  5. Sinetöi: sinetöity PDF (valmistumistodistuksineen) on valmis, kun envelope.sealed saapuu.
  6. Tarkista: kuka tahansa voi pudottaa PDF:n tarkistussivulle tai kutsua julkista tarkistus-API:a.

Mikä tekee API:sta mukavan käyttää

Osio nimeltä “Mikä tekee API:sta mukavan käyttää”
  • Virheet, joiden perusteella voi toimia. Jokainen virhe on RFC 9457 problem+json; validointivirheissä on JSON Pointer jokaista ongelmaa kohden, esimerkiksi /variables/client/email.
  • Turvalliset uudelleenyritykset. Lähetä POST-pyyntöjen mukana Idempotency-Key, niin uudelleenyritys toistaa ensimmäisen vastauksen.
  • Ilmainen, rajaton testitila. bf_test_-avaimet luovat vesileimattuja kirjekuoria, joita ei koskaan laskuteta. Katso Todennus.
  • Standardia noudattavat webhookit. Toimitukset allekirjoitetaan Standard Webhooks -määrityksen mukaisesti, niitä yritetään uudelleen kolmen päivän ajan, ja ne voi toistaa.
  • OpenAPI 3.1, koodista generoitu. Viite ja ladattavat openapi.json / openapi.yaml koostetaan samoista zod-sopimuksista, joilla API validoi.

Seuraavat vaiheet

Osio nimeltä “Seuraavat vaiheet”
PikaopasAPI-avain, kirjekuori mallista, allekirjoitus ja valmistumisen webhook kymmenessä minuutissa.
KäsitteetMallit, roolit, kentät, kirjekuoret, vastaanottajat, istunnot ja organisaatiot.
Upotettu allekirjoitusTuo allekirjoituskokemus tuotteeseesi -komponentilla.
TarkistusMiten sinetöinti ja ankkurointi toimivat ja miten tarkistat asiakirjan itse.

API sijaitsee osoitteessa https://api.bonafidesign.com. Kaikki tämän dokumentaation polut ovat suhteessa siihen.