Ninawezaje kuongeza saini za kielektroniki kwenye programu yangu kwa API ya Sealique?
Unda hati kwa POST moja kwenda /api/v1/documents, waache wanaosaini wasaini kupitia viungo vinavyorudishwa, pokea webhooks zilizosainiwa kwa HMAC na upate PDF iliyofungwa yenye saini yake ya kidijitali ya PAdES.
API ya Sealique ni API ya kawaida ya REST chini ya /api/v1 yenye maelezo ya OpenAPI 3.1, funguo za bearer katika hali ya majaribio na halisi, funguo za idempotency, vikomo vya maombi kwa kila ufunguo na webhooks zilizosainiwa kwa HMAC. Vituo vya uthibitishaji havihitaji ufunguo kabisa, hivyo mfumo wowote unaweza kukagua PDF iliyofungwa. Ukurasa huu ni muhtasari; marejeo kamili yenye kila ombi na jibu yako kwenye nyaraka za wasanidi.
Soma nyaraka za wasanidi Thibitisha hati iliyosainiwa
Mambo muhimu
- Ombi moja huunda hati na kuituma: POST /api/v1/documents pamoja na PDF, wanaosaini na mpangilio wa kusaini hurudisha hati na kiungo binafsi cha kusaini kwa kila anayesaini.
- Funguo zinapatikana katika hali ya majaribio na halisi (af_test_… na af_live_…) zenye mawanda documents:read, documents:write, verify na webhooks; kikomo chaguomsingi ni maombi 120 kwa dakika kwa kila ufunguo.
- Webhooks huwasilisha document.sent, signer.opened, signer.signed, signer.declined, document.completed, document.finalized na document.canceled, kila moja ikisainiwa kwa kichwa cha HMAC na kujaribiwa tena ikishindikana.
- GET /api/v1/verify/{verification_id} na POST /api/v1/verify (kupakia) ni za umma: bila ufunguo, zikiwa na kikomo cha maombi 20 kwa dakika kwa kila IP.
- PDF iliyofungwa na cheti cha ukamilifu hupatikana kwa GET /api/v1/documents/{id}/file na /certificate; ukurasa wa kusaini unaweza kupachikwa kwenye tovuti yako kupitia asili zinazoruhusiwa.
Ninawezaje kutuma PDF isainiwe kutoka kwenye msimbo?
Unda ufunguo wa API chini ya Muunganisho, kisha ita POST /api/v1/documents kama multipart (file, title, signers kama mfuatano wa JSON, signing_order) au kama JSON yenye file_base64. Ongeza kichwa cha Idempotency-Key ili jaribio la kurudia lisiunde hati mbili kamwe. Jibu lina kitambulisho cha hati, hali yake na signing_links, kimoja kwa kila anayesaini. Wanaosaini hufungua kiungo, hukubali kauli za ridhaa na kusaini; kwa auto_finalize (chaguomsingi) hati hufungwa mara tu anayesaini wa mwisho anaposaini.
Mfano wa 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"
Mfano wa 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()
Mfano wa 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();
Ninawezaje kujua hati imesainiwa lini?
Sajili kituo cha webhook (POST /api/v1/webhooks au ukurasa wa Muunganisho) na ujiandikishe kwa matukio unayohitaji. Kila uwasilishaji ni mwili wa JSON wenye jina la tukio na hati, uliosainiwa kwa HMAC juu ya muhuri wa muda na mwili katika kichwa cha saini ili uweze kukataa maombi ya kughushi; uwasilishaji ulioshindikana hujaribiwa tena. Kuuliza mara kwa mara GET /api/v1/documents/{id} hurudisha hali ile ile, verification_id na verify_url mara hati inapofungwa.
Ninawezaje kupata na kuthibitisha PDF iliyofungwa?
GET /api/v1/documents/{id}/file hurudisha PDF iliyofungwa na /certificate hurudisha cheti cha ukamilifu, zote zikihitaji wanda la documents:read. Ili kuthibitisha faili kutoka popote, ita GET /api/v1/verify/{verification_id} au POST /api/v1/verify pamoja na PDF; zote ni za umma na hurudisha wanaosaini, muda wa kufungwa na msimbo wa uadilifu kama vile authentic, modified_after_sealing au flattened_copy. GET /api/v1/verify/{id}/page/{page}/{digest} hukagua alama ya ukurasa mmoja.
Je, ninaweza kupachika ukurasa wa kusaini kwenye programu yangu?
Ndiyo. Weka asili zinazoruhusiwa kwenye ufunguo wa API; ukurasa wa kusaini kisha hutuma Content-Security-Policy inayoruhusu asili yako kuuweka kwenye fremu, na baada ya kusaini huelekeza kwenye return_url yako na kutuma ujumbe wenye tukio kwa dirisha mzazi. Wanaosaini hawahitaji akaunti kamwe.
API inagharimu kiasi gani?
Hakuna chochote kwa sasa: funguo za majaribio na halisi zimejumuishwa katika kila akaunti, zikiwa na maombi 120 kwa dakika kwa kila ufunguo kwa chaguomsingi na hati za majaribio (sandbox) zisizotuma barua pepe. Maelezo ya OpenAPI yaliyo kwenye /api/v1/openapi.json yanaweza kuingizwa katika Postman, Insomnia au kitengeneza msimbo.
API ya saini ya kielektroniki inajumuisha nini
- API ya REST chini ya /api/v1 yenye maelezo ya OpenAPI 3.1
- Funguo za majaribio na halisi zenye mawanda na muda wa kuisha
- Funguo za idempotency na vikomo vya maombi kwa kila ufunguo
- Webhooks zilizosainiwa kwa HMAC zenye majaribio ya kurudia
- Vituo vya umma vya uthibitishaji bila ufunguo
- Ukurasa wa kusaini unaopachikwa wenye return_url
Maswali ambayo watu huuliza
Je, API inagharimu chochote?
Hapana. Funguo za API na webhooks zimejumuishwa katika kila akaunti kwa sasa, na uthibitisho ni wa umma; kikomo cha maombi 120 kwa dakika kwa kila ufunguo hutumika kwa chaguomsingi.
Je, naweza kuthibitisha PDF iliyosainiwa kupitia API bila ufunguo?
Ndiyo. GET /api/v1/verify/{verification_id} na POST /api/v1/verify ni za umma, zikiwa na kikomo cha maombi 20 kwa dakika kwa kila IP.
Ni matukio gani ya webhook yaliyopo?
document.sent, signer.opened, signer.signed, signer.declined, document.completed, document.finalized na document.canceled, pamoja na ping kwa ajili ya majaribio.
Webhook zinalindwa vipi?
Kila uwasilishaji hubeba saini ya HMAC juu ya muhuri wa muda na mwili wa ujumbe, iliyokokotolewa kwa siri ya endpoint; ithibitishe kabla ya kuamini data iliyotumwa.
URL za endpoint hukaguliwa dhidi ya anwani za mitandao ya ndani kabla ya uwasilishaji wowote.
Je, kuna mazingira ya majaribio (sandbox)?
Ndiyo. Hati zinazoundwa kwa ufunguo wa majaribio ni hati za sandbox: mchakato ni uleule lakini hakuna barua pepe zinazotumwa kwa wasaini.