API Documentation - Kategori Buku

Berikut adalah cara untuk mengakses daftar kategori menggunakan API:

Endpoint

GET /categories

Autentikasi

Untuk mengakses API ini, Anda perlu mengirimkan kode autentikasi melalui header MISCHOOL-CODE yang diterima setelah meminta akses dari admin.

Contoh Permintaan API

Gunakan perintah curl berikut untuk mendapatkan daftar kategori:

    curl --location 'https://pleiades.mizanforschool.com/categories' \
    --header 'MISCHOOL-CODE: {{ MISCHOOL_CODE }}'
                

Respons API

Jika permintaan berhasil, Anda akan mendapatkan respons berupa daftar kategori dalam format JSON seperti berikut:

    {
        "status": true,
        "message": "Successfully get categories",
        "data": [
            {
                "id": 125,
                "name": "Agama",
                "total_books": 1
            },
            {
                "id": 117,
                "name": "Alam dan Lingkungan",
                "total_books": 1
            },
            {
                "id": 115,
                "name": "Fiksi",
                "total_books": 2
            },
            {
                "id": 105,
                "name": "Fauna",
                "total_books": 1
            },
            {
                "id": 102,
                "name": "Sains",
                "total_books": 1
            }
        ]
    }
                

Respons Error

Jika terjadi kesalahan, misalnya MISCHOOL-CODE yang tidak valid, API akan mengembalikan respons error seperti berikut:

    {
      "status": "error",
      "message": "Unauthorized: Invalid MISCHOOL-CODE."
    }