API tandatangan untuk pembangun perisian

Pengenalan

Reka bentuk API tandatangan diluluskan selepas medan dan peristiwa diasingkan.

Kontrak API antara aplikasi dan platform tandatangan ditulis dari arah medan: data apa yang masuk, peristiwa apa yang direkodkan dan bagaimana hasil dibaca semula.

Nota Sign boleh menyokong aliran tandatangan digital dan elektronik, termasuk kaedah berasaskan sijil apabila ditetapkan dalam konfigurasi. Platform merekodkan proses teknikal; kesan undang-undang tetap bergantung pada dokumen, pihak dan undang-undang yang berkenaan.

Tetapkan dokumen dan medan

Tetapkan dokumen kontrak API dan medan yang diisi oleh setiap pihak. Setiap medan dicatatkan dengan jenis data dan pemiliknya.

Catatkan medan wajib dan medan pilihan dalam jadual. Medan wajib yang kosong menghentikan panggilan tandatangan.

Rekodkan versi dokumen dan tarikh semakan medan. Versi yang berubah memerlukan semakan semula jadual medan.

Asingkan medan tandatangan daripada medan data biasa. Pemisahan itu menghalang data biasa dibaca sebagai tindakan tandatangan.

Rekodkan peristiwa API

Rekodkan peristiwa API yang dihasilkan semasa aliran: penciptaan dokumen, penghantaran, tandatangan dan penyiapan. Setiap peristiwa dicatatkan dengan rujukan dokumen.

Catatkan masa setiap peristiwa dan sumber masanya. Sumber masa yang sama menghalang kekeliruan urutan.

Rekodkan peristiwa yang gagal dan kod ralat yang dikembalikan. Kegagalan dicatatkan supaya integrasi tidak meninggalkan jurang.

Asingkan peristiwa tandatangan daripada peristiwa pentadbiran akaun. Dua jenis peristiwa berasingan menghalang kekeliruan pemilik.

Asingkan data medan

Asingkan data medan daripada metadata peristiwa dalam setiap panggilan API. Data medan tidak ditulis semula apabila metadata berubah.

Catatkan setiap medan dengan laluan datanya dalam kontrak API. Laluan itu membolehkan semakan nilai tanpa membaca seluruh beban panggilan.

Rekodkan nilai medan yang diubah dan versi dokumen yang berkaitan. Perubahan dicatatkan bersama sebab dan tarikh.

Asingkan medan baca sahaja daripada medan boleh tulis. Medan baca sahaja tidak menerima nilai daripada aplikasi luar.

Semak hasil tandatangan

Semak hasil tandatangan yang dikembalikan API terhadap dokumen yang diminta. Hasil itu dicatatkan bersama status dan rujukan tandatangan.

Simpan nilai semakan dokumen sumber dan dokumen bertandatangan sebagai rekod yang berasingan. Oleh sebab data tandatangan ditambah pada fail akhir, kedua-dua nilai tidak dijangka sama; pengesahan perlu memastikan kandungan yang dilindungi kekal utuh dan hasil itu berkaitan dengan permintaan asal.

Rekodkan sijil dan masa yang dilampirkan pada hasil. Sijil itu menghubungkan hasil kepada penandatangan.

Asingkan hasil berjaya daripada hasil gagal dalam jadual semakan. Dua hasil berasingan menghalang kegagalan dibaca sebagai kejayaan.

Luluskan reka bentuk API

Semak semula medan, peristiwa, pengasingan data dan hasil sebelum kelulusan. Reka bentuk yang tidak lengkap kembali ke langkah yang gagal.

Tulis nama pelulus reka bentuk, tarikh kelulusan dan keputusan akhir. Keputusan diterima atau ditolak direkodkan bersama sebab.

Simpan reka bentuk bersama kontrak API dalam folder pembangun. Reka bentuk itu menjadi rujukan apabila integrasi disemak.

Agihkan reka bentuk kepada pembangun dan penyemak. Setiap salinan menunjuk kepada versi kontrak yang sama.