Dokumentasi ini menjelaskan semua metode API untuk tindakan berikut:

• mendapatkan daftar objek (metode daftar)
• pemfilteran daftar (metode daftar dengan data filter)
• mendapatkan informasi rinci tentang suatu objek (show method)
• mendapatkan data untuk formulir tambah objek (tambahkan metode)
• menyimpan data sebagai objek baru (metode penyimpanan)
• mendapatkan data untuk formulir pembaruan objek (metode edit)
• menyimpan data objek yang diperbarui (metode pembaruan)

API hanya menerima permintaan dari daftar alamat IP terbatas (misalnya, dari situs akun klien atau situs back office).

Setiap permintaan ke API dari alamat IP yang tidak ada dalam daftar yang diizinkan akan ditolak.

Ini dilakukan untuk mencegah serangan DDoS pada API, upaya memalsukan permintaan, dan eksperimen peretas.

Pengguna selalu mengakses situs publik platform (kantor pelanggan atau back office), dan situs ini sendiri meminta data yang diperlukan dari API platform. Karena alamat IP situs sudah diperbaiki, itu akan ada di daftar yang diizinkan.

Semua permintaan API dibuat menggunakan metode HTTP berikut:

• GET untuk daftar, tampilkan, tambahkan, dan edit
• POST untuk toko
• PUT untuk pembaruan
• DELETE untuk menghapus

Setiap bagian API berisi URL tempat permintaan dibuat untuk mendapatkan data yang relevan.

Metode permintaan HTTP ditentukan di depan setiap URL.

Setiap permintaan API harus selalu berisi 4 variabel:

1. data (string json dengan array data untuk API)
2. user (string json dengan larik data tentang pengguna saat ini)
3. time (waktu saat ini dalam zona waktu UTC)
4. hash (tanda tangan digital berupa hash untuk memverifikasi bahwa permintaan ke API pasti dari sumber yang berwenang)

Jika permintaan berhasil, API selalu mengembalikan dua variabel:

1. status = true (status sukses)
2. data (string json dengan array data dari API)

Jika permintaan gagal, API menampilkan variabel:

1. status = false (status kesalahan)
2. error (string teks yang menjelaskan kesalahan)

Setiap permintaan API harus berisi variabel hash yang merupakan tanda tangan digital dari permintaan tersebut.

hash = md5($json . $time . $salt)

• md5, sha256, bcrypt — algoritma enkripsi yang tersedia
• $json — string json dengan data permintaan
• $time — waktu dalam format "DD.MM.YYYY HH:MM:SS"
• $salt — nilai unik tetap ("garam") untuk platform API