Nongera nte imikono ya elegitoroniki muri porogaramu yanjye nkoresheje API ya Sealique?
Kora inyandiko ukoresheje POST imwe kuri /api/v1/documents, abashyira umukono basinye bakoresheje imirongo yagarutse, wakire webhooks zashyizweho umukono wa HMAC kandi ukurure PDF yafunzwe ifite umukono wa dijitali wa PAdES.
API ya Sealique ni API ya REST isanzwe iri munsi ya /api/v1 ifite ibisobanuro bya OpenAPI 3.1, infunguzo za bearer mu buryo bwo kugerageza no mu buryo nyabwo, infunguzo za idempotency, imipaka y'ibisabwa kuri buri rufunguzo na webhooks zishyirwaho umukono wa HMAC. Endpoint zo kugenzura ntizikenera urufunguzo na rumwe, bityo uburyo ubwo ari bwo bwose bushobora kugenzura PDF yafunzwe. Uru rupapuro ni incamake; ibisobanuro byuzuye bya buri gisabwa n'igisubizo biri mu nyandiko z'abakora porogaramu.
Soma inyandiko z'abakora porogaramu Genzura inyandiko yashyizweho umukono
Ingingo z'ingenzi
- Igisabwa kimwe gikora inyandiko kikayohereza: POST /api/v1/documents hamwe na PDF, abashyira umukono n'uburyo bwo gukurikirana bagaruka inyandiko n'umurongo bwite wo gusinya kuri buri ushyira umukono.
- Infunguzo ziboneka mu buryo bwo kugerageza no mu buryo nyabwo (af_test_… na af_live_…) zifite uburenganzira documents:read, documents:write, verify na webhooks; umubare usanzwe wemewe ni ibisabwa 120 ku munota kuri buri rufunguzo.
- Webhooks zitanga document.sent, signer.opened, signer.signed, signer.declined, document.completed, document.finalized na document.canceled, buri imwe ishyirwaho umukono wa HMAC mu mutwe kandi ikongera kugeragezwa iyo inaniwe.
- GET /api/v1/verify/{verification_id} na POST /api/v1/verify (kohereza dosiye) ni rusange: nta rufunguzo, bigarukira ku bisabwa 20 ku munota kuri buri IP.
- PDF yafunzwe n'icyemezo cyo kurangiza bikururwa ukoresheje GET /api/v1/documents/{id}/file na /certificate; urupapuro rwo gusinya rushobora gushyirwa mu rubuga rwawe binyuze mu nkomoko zemewe.
Nohereza nte PDF ishyirweho umukono nkoresheje kode?
Kora urufunguzo rwa API munsi ya Guhuza na porogaramu, hanyuma uhamagare POST /api/v1/documents nka multipart (file, title, signers nk'umurongo wa JSON, signing_order) cyangwa nka JSON hamwe na file_base64. Ongeraho umutwe wa Idempotency-Key kugira ngo kongera kugerageza bitazigera bikora inyandiko ebyiri. Igisubizo kirimo id y'inyandiko, uko ihagaze na signing_links, umwe kuri buri ushyira umukono. Abashyira umukono bafungura umurongo, bemera amagambo yo kwemera bagashyira umukono; hamwe na auto_finalize (uburyo busanzwe) inyandiko ifungwa ako kanya ushyira umukono wa nyuma amaze gusinya.
Urugero rwa curl: curl -X POST https://your-host/api/v1/documents -H "Authorization: Bearer af_test_…" -H "Idempotency-Key: order-1042" -F "file=@contract.pdf" -F "title=Service agreement" -F 'signers=[{"name":"Aline Uwase","email":"aline@example.com"}]' -F "signing_order=sequential"
Urugero rwa Python: requests.post(base + "/api/v1/documents", headers={"Authorization": "Bearer af_test_…"}, files={"file": open("contract.pdf", "rb")}, data={"title": "Service agreement", "signers": '[{"name": "Aline Uwase", "email": "aline@example.com"}]'}).json()
Urugero rwa JavaScript: const form = new FormData(); form.append("file", pdfBlob, "contract.pdf"); form.append("title", "Service agreement"); form.append("signers", JSON.stringify([{ name: "Aline Uwase", email: "aline@example.com" }])); const doc = await (await fetch(base + "/api/v1/documents", { method: "POST", headers: { Authorization: "Bearer af_test_…" }, body: form })).json();
Namenya nte igihe inyandiko yashyizweho umukono?
Andikisha endpoint ya webhook (POST /api/v1/webhooks cyangwa urupapuro rwa Guhuza na porogaramu) hanyuma wiyandikishe ku bikorwa ukeneye. Buri butumwa ni umubiri wa JSON urimo izina ry'igikorwa n'inyandiko, washyizweho umukono wa HMAC ku gihe no ku mubiri mu mutwe w'umukono kugira ngo ushobore kwanga amahamagara y'ibinyoma; ubutumwa bwananiwe bwongera kugeragezwa. Kubaza GET /api/v1/documents/{id} bigarura uko ihagaze, verification_id na verify_url bimwe imaze gufungwa.
Nkurura nkanagenzura nte PDF yafunzwe?
GET /api/v1/documents/{id}/file igarura PDF yafunzwe naho /certificate igarura icyemezo cyo kurangiza, byombi bikenera uburenganzira documents:read. Kugira ngo ugenzure dosiye uri aho ari ho hose, hamagara GET /api/v1/verify/{verification_id} cyangwa POST /api/v1/verify hamwe na PDF; byombi ni rusange kandi bigarura abashyize umukono, igihe cyo gufunga na kode y'ubusugire nka authentic, modified_after_sealing cyangwa flattened_copy. GET /api/v1/verify/{id}/page/{page}/{digest} igenzura ikimenyetso cy'urupapuro rumwe.
Nshobora gushyira urupapuro rwo gusinya muri porogaramu yanjye?
Yego. Shyiraho inkomoko zemewe ku rufunguzo rwa API; urupapuro rwo gusinya rwohereza Content-Security-Policy yemerera inkomoko yawe kurushyira mu idirishya, kandi nyuma yo gusinya rwerekeza kuri return_url yawe rukohereza ubutumwa ku idirishya ribyeyi burimo igikorwa. Abashyira umukono ntibakenera konti na rimwe.
API igura angahe?
Nta na kimwe uyu munsi: infunguzo zo kugerageza n'iz'uburyo nyabwo ziza na buri konti, hamwe n'ibisabwa 120 ku munota kuri buri rufunguzo mu buryo busanzwe n'inyandiko za sandbox zidatanga imeyili. Ibisobanuro bya OpenAPI biri kuri /api/v1/openapi.json bishobora kwinjizwa muri Postman, Insomnia cyangwa igikoresho gikora kode.
Ibyo API y'umukono wa elegitoroniki ikubiyemo
- API ya REST munsi ya /api/v1 ifite ibisobanuro bya OpenAPI 3.1
- Infunguzo zo kugerageza n'iz'uburyo nyabwo zifite uburenganzira n'igihe zirangirira
- Infunguzo za idempotency n'imipaka y'ibisabwa kuri buri rufunguzo
- Webhooks zishyirwaho umukono wa HMAC zongera kugeragezwa
- Endpoint rusange zo kugenzura zidakenera urufunguzo
- Urupapuro rwo gusinya rushobora gushyirwa mu rubuga rwawe hamwe na return_url
Ibibazo abantu babaza
API ihenda?
Oya. Infunguzo za API na webhooks ziza na buri konti uyu munsi, kandi kugenzura ni rusange; buri rufunguzo rugira umubare ntarengwa w'ibisabwa 120 ku munota mu buryo busanzwe.
Nshobora kugenzura PDF yashyizweho umukono binyuze kuri API ntafite urufunguzo?
Yego. GET /api/v1/verify/{verification_id} na POST /api/v1/verify ni rusange, bigarukira kuri 20 requests ku munota kuri buri IP.
Ni ibihe bikorwa bya webhook bihari?
document.sent, signer.opened, signer.signed, signer.declined, document.completed, document.finalized na document.canceled, hiyongereyeho ping yo kugerageza.
Webhook zirindwa zite?
Buri kohereza kuzana umukono wa HMAC ubariwe ku gihe (timestamp) no ku mubiri w'ubutumwa, hakoreshejwe ibanga rya endpoint; ugenzure mbere yo kwizera ibyoherejwe.
URL za endpoint zigenzurwa ko zitari mu bice by'imiyoboro y'imbere (private network) mbere y'uko hagira icyoherezwa.
Hari sandbox yo kugerageza?
Yego. Inyandiko zakozwe n'urufunguzo rwo kugerageza ni inyandiko za sandbox: inzira ni imwe, ariko nta imeri yoherezwa ku bashyira umukono.