Dokumen Proses Integrasi API
Panduan Instalasi Sign Gateway Xignature
Prasyarat Sistem
Sebelum melakukan instalasi Sign Gateway Xignature, pastikan perangkat telah memenuhi persyaratan berikut:
-
Sistem Operasi
-
Windows 10 64-bit (Pro/Enterprise/Education 21H2 atau lebih baru) dengan WSL 2 aktif.
-
macOS 10.15 (Catalina) atau lebih baru.
-
Linux (Ubuntu, Debian, Fedora, atau distribusi lain yang didukung Docker).
-
-
Spesifikasi Minimum
-
RAM minimal 4 GB.
-
Hardware Virtualization telah diaktifkan pada BIOS/UEFI.
-
Docker Desktop atau Docker Engine telah terinstal dan berjalan dengan baik.
-
Pastikan Docker telah terinstall pada server yang akan digunakan.
1. Login ke Docker Registry
Jalankan perintah berikut untuk login ke Docker Registry Xignature:
docker login registry.xignature.co.id -u public
Password akan diinformasikan melalui personal message/chat.
2. Pull Image Terbaru
Unduh image Sign Gateway terbaru menggunakan perintah berikut:
docker pull registry.xignature.co.id/xignature/public-sign-gateway:2.1.5
3. Install Sign Gateway
Jalankan container menggunakan perintah berikut:
docker run -d \
--name sign-gateway \
-p 1303:1303 \
-e API_URL=https://staging-api.xignature.dev \
-e API_KEY=<your-api-key> \
-e ENV=STAGING \
-e OTEL_SERVICE_NAME=<nama-perusahaan-anda> \
registry.xignature.co.id/xignature/public-sign-gateway:2.1.5
Keterangan Parameter
| Parameter | Keterangan |
|---|---|
| API_URL | URL API Xignature (Staging) |
| API_KEY | API Key yang diberikan oleh tim Xignature |
| ENV | Environment yang digunakan (STAGING) |
| OTEL_SERVICE_NAME | Nama perusahaan atau aplikasi yang digunakan sebagai identitas service |
Flow Umum Proses Tanda Tangan
Setelah Sign Gateway berhasil dijalankan, berikut urutan proses integrasi tanda tangan digital:
1. Registrasi
Dokumentasi:
https://support.xignature.co.id/api-reference/endpoint/authentication/registration-copied-1
2. Generate PAT (Personal Access Token)
Dokumentasi:
https://support.xignature.co.id/api-reference/endpoint/authentication/gen-pat-copied-1
3. Proses Tanda Tangan (Sign)
Dokumentasi:
https://support.xignature.co.id/api-reference/endpoint/stamp-copied-1/single
Flow Proses E-Meterai
Untuk penggunaan E-Meterai, ikuti tahapan berikut:
1. Generate Serial Number (SN)
Dokumentasi:
https://support.xignature.co.id/api-reference/endpoint/emeterai-copied-1/generate
2. Stamp E-Meterai
Dokumentasi:
https://support.xignature.co.id/api-reference/endpoint/stamp-copied-1/emeterai
Catatan
-
Pastikan Docker telah berjalan sebelum melakukan instalasi.
-
Gunakan API Key yang telah diberikan oleh tim Xignature.
-
Password Docker Registry akan diberikan melalui jalur komunikasi pribadi (personal message/chat).
-
Apabila menggunakan environment Production, sesuaikan nilai API_URL, ENV, serta image yang digunakan sesuai informasi dari tim Xignature.