• TBD
• General
  • Administrasi Pengguna
    • Registrasi Admin
    • Penghapusan Admin
• REST API
  • Autentikasi
    • Log In
    • Log Out
  • Partner
    • Mengambil partner tertentu
    • Mengambil semua partner
    • Mengambil semua partner dengan metadata
    • Mendaftarkan Partner Baru
    • Mengubah Partner
    • Menghapus Partner Tertentu
  • Review
    • Mengambil semua review publik
    • Mengambil semua review, termasuk yang disembunyikan, dengan metadata
    • Mengambil review tertentu
    • Menyembunyikan review
    • Menampilkan review
    • Membuat Review Baru
    • Menghapus review
  • Menu Satuan
    • Mengambil semua menu satuan
    • Mengambil semua menu satuan dengan metadata
    • Mengambil menu satuan tertentu
    • Membuat menu satuan baru
    • Memperbaru menu satuan tertentu
    • Menghapus menu satuan tertentu
  • Menu Paket
    • Mengambil semua data menu paket
    • Mengambil semua data menu paket dengan metadata
    • Mengambil data menu paket tertentu
    • Mengambil semua menu satuan untuk menu paket tertentu
    • Membuat menu paket baru
    • Memperbaru menu paket tertentu
    • Menghapus menu paket tertentu

• Captcha in review form

Pendaftaran dan penghapusan akun admin tidak tersedia melalui antarmuka web. Kedua aksi tersebut dilakukan melalui perintah Artisan custom berikut.

php artisan admin:new <name> <password>

php artisan admin:delete <name>

Sebelum membaca lebih jauh, ada beberapa konvensi yang REST API ini patuhi. Developer yang menggunakan REST API ini diharapkan mampu memahami konvensi tersebut dan menggunakannya sesuai dengan konvensi yang telah ditetapkan.

REST API ini menggunakan JSON sebagai format pertukaran data, kecuali di beberapa endpoint yang menerima file seperti di /api/partner/ dan /api/paket/ untuk method POST dan PUT. Request untuk endpoint tersebut harus memiliki body dengan MIME type multipart/form-data.

Karena API ini menggunakan Laravel, semua request PUT adalah request POST dengan field tambahan _method yang memiliki nilai 'PUT.'

{
    ...other data
    "_method" : "PUT"
}

Semua endpoint dengan HTTP method POST, PUT, dan DELETE adalah endpoint yang terlindungi.

Ada dua endpoint index, /api/{resource}/ dan /api/{resource}/index.

/api/{resource}/index adalah endpoint yang dilindungi dan memerlukan autentikasi. Endpoint tersebut ditujukan untuk digunakan di dashboard.

Sementara itu, /api/{resource}/ ditujukan untuk digunakan secara publik, dengan beberapa fitur data disembunyikan untuk menghemat waktu query.

Request yang mengakses endpoint yang terlindungi perlu menambahkan header Authentication dengan nilai {tipe_token} {token}. Keduanya dapat diakses melalui endpoint log in.

POST      /api/login

REST API ini menggunakan Bearer token untuk autentikasi. Token dapat diakses dengan melakukan request dengan username dan password admin yang telah didaftarkan sebelumnya melalui command prompt.

Contoh request:

{
    "name" : "string",
    "password" : "string"
}

Contoh response:

{
    "message": "Login success",
    "access_token": "TOKEN",
    "token_type": "Bearer"
}

POST      /api/logout

Endpoint ini terlindungi. Request ke endpoint ini tidak memerlukan body. Endpoint ini membuat semua token dari user menjadi tidak valid.

Secara umum, respons untuk method GET kelompok endpoint ini kurang lebih seperti berikut.

{
    "nama" : "Partner",
    "logo" : "path/to/logo"
}

GET       /api/partner/{id}

GET       /api/partners

GET       /api/partners/index

Endpoint ini terlindungi.

POST      /api/partner

Fields:
    name: required, string
    logo: required, file, image

Endpoint ini terlindungi.

PUT       /api/partner/{id}

Fields:
    name: optional, string
    logo: optional, file, image

Endpoint ini terlindungi.

DELETE    /api/partner/{id}

Endpoint ini terlindungi. Request ke endpoint ini tidak memerlukan body.

Secara umum, respons untuk method GET kelompok endpoint ini kurang lebih seperti berikut.

{
    "id" : 0,
    "reviewer_name" : "Fulan",
    "content" : "Lorem ipsum dolor sit amet..."
}

Untuk mengontrol visibilitas review, dapat menggunakan endpoint (/api/review/{id}/show)[#menyembunyikan-review] dan (/api/review/{id}/show)[#menampilkan-review]

GET       /api/reviews

GET       /api/reviews/index

Endpoint ini terlindungi.

GET       /api/review/{id}

POST      /api/review/{id}/hide

Endpoint ini terlindungi. Request ke endpoint ini tidak memerlukan body.

POST      /api/review/{id}/show

Endpoint ini terlindungi. Request ke endpoint ini tidak memerlukan body.

POST      /api/review

Fields:
    reviewer_name: required, string
    content: required, text

Endpoint ini terlindungi.

DELETE    /api/review/{id}

Endpoint ini terlindungi. Request ke endpoint ini tidak memerlukan body.

GET       /api/satuans

GET       /api/satuans/index

Endpoint ini terlindungi.

GET       /api/satuan/{id}

POST      /api/satuan

Fields:
    nama: required, string

Endpoint ini terlindungi.

PUT       /api/satuan/{id}

Fields:
    nama: optional, string

Endpoint ini terlindungi.

DELETE    /api/satuan/{id}

Endpoint ini terlindungi. Request ke endpoint ini tidak memerlukan body.

GET       /api/pakets

GET       /api/pakets/index

Endpoint ini terlindungi.

GET       /api/paket/{id}

GET       /api/paket/{id}/items

POST      /api/paket

Fields:
    name: required, string
    harga: required, unsigned integer
    kategori: required, 'nasi_kotak' OR 'prasmanan'
    foto: required, file, image
    items: optional, array<satuan_id>

Endpoint ini terlindungi.

/api/paket/{id}

Fields:
    name: optional, string
    harga: optional, unsigned integer
    kategori: optional, 'nasi_kotak' OR 'prasmanan'
    foto: optional, file, image
    items: optional, array<satuan_id>

Endpoint ini terlindungi.

DELETE    /api/paket/{id}

Endpoint ini terlindungi. Request ke endpoint ini tidak memerlukan body.