PENGENALAN API

ISI

Plugin JSONku API (Application Programming Interface) dirancang untuk menyediakan cara mudah untuk mengintegrasikan sistem lain dengan JSONku. Dengan plugin ini, Anda dapat mengambil atau memperbarui data dari database dengan permintaan HTTP sederhana.

Instalasi

JSONku hadir dengan plugin API yang sudah diinstal sebelumnya, Anda hanya perlu mengaktifkannya dari bagian plugin.

Admin panel > Plugins > API > Activate

URL

URL dari API tersebut adalah:

{protocol}://{domain}/api/{endpoint}

Contoh:

https://www.example.com/api/pages

Titik Akhir dan Metode

titik akhir	metode	deskripsi
/pages	`GET`	Menampilkan daftar halaman
/pages/{page key}	`GET`	Menampilkan halaman dengan kunci halaman
/pages	`POST`	Buat halaman baru
/pages/{page key}	`PUT`	Edit halaman
/pages/{page key}	`DELETE`	Hapus halaman
/settings	`GET`	Mengembalikan pengaturan JSONku
/settings	`PUT`	Edit pengaturan JSONku
/images	`POST`	Unggah gambar dan buat thumbnail untuk sebuah halaman
/tags	`GET`	Menampilkan daftar tag dan kunci halaman yang terkait dengan tag
/tags/{tag key}	`GET`	Mengembalikan tag dengan kunci tag
/categories	`GET`	Menampilkan daftar kategori dan kunci halaman yang terkait dengan kategori tersebut
/categories{category key}	`GET`	Mengembalikan kategori berdasarkan kunci kategori
/users/	`GET`	Menampilkan daftar pengguna di sistem
/users/{username}	`GET`	Menampilkan pengguna profil
/files/{page key}	`GET`	Mengembalikan file yang terkait dengan halaman

Respon HTTP

Format konten tanggapan adalah Content-Type: application/json.

Nilai default untuk tubuh.

kunci	Tipe	deskripsi
status	string	Mengembalikan 0 untuk sukses.
message	string	Mengembalikan sedikit pesan tentang eksekusi.
data	array	Isi tanggapan untuk titik akhir.

Kode status HTTP

Kode HTTP	deskripsi
200	Respon berhasil.
400	Permintaan buruk, masukan hilang.
401	Token API atau token autentikasi tidak ada atau salah.