Menangani Tanda Tangan API

Tanda tangan API adalah mekanisme keamanan yang memverifikasi keaslian dan integritas permintaan. Panduan ini menunjukkan cara mengotomatiskan pembuatan tanda tangan di Apidog, sehingga menghilangkan kebutuhan untuk mengambil tanda tangan secara manual untuk setiap permintaan.

Strategi Otomatisasi Tanda Tangan

Alih-alih mengakses endpoint tanda tangan secara manual sebelum setiap permintaan, gunakan kemampuan scripting Apidog untuk:

Membuat skrip publik yang mengimplementasikan logika tanda tangan

Menghasilkan tanda tangan secara otomatis menggunakan parameter permintaan

Melampirkan tanda tangan ke permintaan melalui skrip atau variabel lingkungan

Mereferensikan skrip publik dalam preprocessor API

Pendekatan Implementasi

Metode 1: Modifikasi Skrip Langsung

Tambahkan parameter tanda tangan dan modifikasi informasi permintaan secara langsung melalui skrip tanpa menggunakan variabel lingkungan.

Keuntungan:

Tidak memerlukan pengelolaan variabel lingkungan

Pembaruan parameter secara langsung

Konfigurasi lebih sederhana

Metode 2: Variabel Lingkungan

Hasilkan tanda tangan dan tuliskan ke variabel lingkungan, lalu referensikan variabel tersebut dalam parameter API.

Keuntungan:

Dapat digunakan kembali di beberapa permintaan

Debugging dan pemantauan lebih mudah

Pengelolaan tanda tangan terpusat

Metode 3: Program Eksternal

Untuk tanda tangan yang diimplementasikan dalam bahasa lain, gunakan metode dog.execute untuk memanggil program eksternal.

Contoh: Tanda Tangan Berbasis MD5

Aturan Pembuatan Tanda Tangan

Langkah 1: Bangun string parameter

Kumpulkan semua parameter yang tidak kosong ke dalam set M

Urutkan parameter berdasarkan kode ASCII secara menaik (urutan kamus)

Gabungkan parameter dalam format key-value URL: key1=value1&key2=value2...

Hasil: stringA

Aturan penting:

Urutkan nama parameter berdasarkan kode ASCII secara menaik

Nilai parameter kosong dikecualikan dari tanda tangan

Nama parameter peka huruf besar/kecil

Parameter sign itu sendiri dikecualikan dari tanda tangan

Langkah 2: Hasilkan tanda tangan

Gabungkan key di akhir stringA untuk memperoleh stringSignTemp

Terapkan algoritma MD5 pada stringSignTemp

Konversi hasilnya menjadi huruf besar untuk memperoleh signValue

Implementasi Skrip Publik

Contoh: Tanda Tangan API Terjemahan

Aturan Pembuatan Tanda Tangan

Langkah 1: Gabungkan string

Gabungkan nilai berikut secara berurutan:

appid: ID aplikasi

q: Teks yang akan diterjemahkan (encoding UTF-8)

salt: Angka acak

key: Key yang ditetapkan platform (tersedia di konsol manajemen)

Hasil: appid + q + salt + key

Langkah 2: Hasilkan tanda tangan

Terapkan algoritma MD5 pada string yang telah digabungkan untuk memperoleh tanda tangan huruf kecil 32-bit.

Catatan penting:

Teks yang akan diterjemahkan (q) harus menggunakan encoding UTF-8

Saat menggabungkan appid+q+salt+key, JANGAN menerapkan URL encoding pada q

Setelah tanda tangan dihasilkan, terapkan URL encoding pada q sebelum mengirim permintaan HTTP

Contoh Permintaan

Implementasi Skrip Publik

Praktik Terbaik

Praktik	Deskripsi
Gunakan Variabel Lingkungan	Simpan key sensitif dalam variabel lingkungan, bukan dalam skrip
Validasi Parameter	Periksa parameter yang diperlukan sebelum menghasilkan tanda tangan
Catat Log untuk Debugging	Gunakan `console.log()` untuk men-debug masalah pembuatan tanda tangan
Tangani Kasus Tepi	Perhitungkan nilai kosong, karakter khusus, dan encoding
Pusatkan Logika	Gunakan skrip publik untuk menghindari duplikasi logika tanda tangan
Uji Secara Menyeluruh	Verifikasi pembuatan tanda tangan dengan kasus pengujian yang sudah diketahui

Menangani Tanda Tangan API

Strategi Otomatisasi Tanda Tangan#

Pendekatan Implementasi#

Metode 1: Modifikasi Skrip Langsung#

Metode 2: Variabel Lingkungan#

Metode 3: Program Eksternal#

Contoh: Tanda Tangan Berbasis MD5#

Aturan Pembuatan Tanda Tangan#

Implementasi Skrip Publik#

Contoh: Tanda Tangan API Terjemahan#

Aturan Pembuatan Tanda Tangan#

Contoh Permintaan#

Implementasi Skrip Publik#

Praktik Terbaik#

Strategi Otomatisasi Tanda Tangan

Pendekatan Implementasi

Metode 1: Modifikasi Skrip Langsung

Metode 2: Variabel Lingkungan

Metode 3: Program Eksternal

Contoh: Tanda Tangan Berbasis MD5

Aturan Pembuatan Tanda Tangan

Implementasi Skrip Publik

Contoh: Tanda Tangan API Terjemahan

Aturan Pembuatan Tanda Tangan

Contoh Permintaan

Implementasi Skrip Publik

Praktik Terbaik