REST API dan dokumentasi API aplikasi Anda

Kadang perangkat lunak lain membutuhkan data aplikasi Anda: situs web mitra yang menampilkan produk Anda, spreadsheet yang menarik pesanan baru, aplikasi seluler, atau alat otomatisasi seperti Zapier atau n8n. Semuanya berkomunikasi dengan aplikasi Anda melalui API — sekumpulan alamat web (endpoint) yang menjawab dengan data, bukan halaman. REST API adalah jenis yang paling umum.

MonstarX membuatkannya untuk Anda tanpa kode. Anda memilih apa yang ingin dibagikan, dan API langsung aktif dalam hitungan detik, lengkap dengan halaman referensi yang bisa dibaca developer.

Di mana saya bisa menemukannya?

Buka proyek Anda, klik Admin di bilah atas, lalu API di bilah samping Admin. Anda akan melihat API proyek: di bagian atas, bilah Referensi API yang menerbitkan dokumentasi API Anda; endpoint Anda di sebelah kiri, masing-masing bertanda Aktif atau Draf; dan Kunci API di bawahnya.

Bagaimana cara membuat endpoint?

1. Di Admin›API, klik Endpoint baru (atau + di samping Endpoint).

2. Pilih Koleksi — tabel yang diolah endpoint tersebut, misalnya Resep.

3. Pilih Operasi:

   Operasi	Metode dan alamat	Fungsinya
   Daftar	GET /recipes	Mengembalikan catatan, satu halaman setiap kali.
   Ambil	GET /recipes/{id}	Mengembalikan satu catatan berdasarkan ID-nya.
   Buat	POST /recipes	Menambahkan catatan.
   Perbarui	PATCH /recipes/{id}	Mengubah sebagian kolom sebuah catatan.
   Hapus	DELETE /recipes/{id}	Menghapus catatan.

4. Beri Nama, Jalur URL, dan jika mau, Deskripsi. Semuanya akan muncul di dokumentasi API.

5. Di Kolom yang dapat diakses, centang persis kolom yang boleh dilihat atau dikirim pemanggil. Kolom yang tidak dicentang tetap privat. Kolom yang tampak sensitif, seperti kata sandi dan token, selalu dikecualikan.

6. Di Akses, pilih siapa yang boleh memanggilnya (lihat di bawah).

7. Centang Terbitkan endpoint, lalu klik Simpan & terbitkan endpoint. Endpoint yang sudah diterbitkan berstatus Aktif: endpoint ini langsung menjawab permintaan. Jika kotak itu tidak dicentang, Simpan endpoint menyimpannya sebagai Draf.

   

Di daftar, setiap endpoint bertanda Aktif atau Draf. Kata yang sama muncul di bawah Edit endpoint, diikuti Perubahan yang belum disimpan sampai Anda menyimpan. Hapus centang Terbitkan endpoint lalu simpan untuk menonaktifkannya tanpa menghapus; Hapus menghapusnya.

Catatan

Buat, Perbarui, dan Hapus mengubah data Anda yang sebenarnya. Sebelum bisa menerbitkan endpoint seperti itu, aktifkan tindakan tersebut (menambah, mengedit, atau menghapus) untuk tabelnya di pengaturan tabel itu pada tab Admin. Lihat Panel admin aplikasi Anda.

Siapa yang bisa memanggil endpoint saya?

Akses	Siapa yang bisa memanggilnya	Tersedia untuk
Akses baca publik	Siapa saja yang punya alamatnya.	Hanya Daftar dan Ambil
Kunci API proyek	Hanya pemanggil yang mengirim salah satu kunci API proyek Anda.	Semua operasi

Endpoint yang mengubah data selalu memerlukan kunci.

Bagaimana cara membuat kunci API?

1. Di Admin›API, klik Kunci API.

2. Ketik nama yang menjelaskan di mana kunci akan dipakai, misalnya “Server widget resep”, lalu klik Buat kunci.

3. Salin kunci saat itu juga — kunci diawali mxapi_ dan tidak dapat ditampilkan kembali. Simpan di tempat yang aman, seperti pengelola kata sandi atau penyimpanan rahasia di layanan lain.

Satu kunci membuka semua endpoint yang dilindungi kunci di proyek ini, jadi beri setiap layanan kuncinya sendiri. Klik Cabut untuk menonaktifkan kunci; apa pun yang memakainya langsung berhenti berfungsi.

Pemanggil mengirim kunci di header Authorization: Authorization: Bearer mxapi_….

Perhatian

Simpan kunci API di server. Kunci yang ditaruh di halaman web atau aplikasi seluler bisa dibaca oleh siapa saja yang memeriksanya.

Bagaimana cara mencoba endpoint?

Buka endpoint, lalu klik Tes. Masukkan ID catatan, Kunci Bearer, atau Isi JSON jika endpoint memerlukannya, lalu klik Kirim permintaan. Anda melihat statusnya (200 berarti berhasil), berapa lama prosesnya, dan jawabannya. Untuk endpoint yang memerlukan kunci, tempel salah satu kunci Anda dari Kunci API ke Kunci Bearer.

Pengujian dikirim ke endpoint aktif yang sebenarnya, jadi:

• Draf belum bisa diuji. Tab Tes bertuliskan Endpoint ini masih berupa draf; klik Simpan & terbitkan endpoint di sana untuk menerbitkan lalu mengujinya.
• Simpan perubahan Anda lebih dulu. Jika ada perubahan yang belum disimpan, tab Tes meminta Anda menyimpan sebelum menguji, dengan tombol Simpan endpoint.

Menguji Buat, Perbarui, atau Hapus akan mengubah data Anda yang sebenarnya.

Tab Kode berisi perintah cURL siap salin, serta file OpenAPI JSON yang bisa diimpor oleh alat API seperti Postman dan Insomnia.

Bagaimana cara menerbitkan dan membagikan dokumentasi API saya?

Dokumentasi API Anda adalah halaman Referensi API untuk developer: setiap endpoint yang aktif, kolomnya, apakah memerlukan kunci, kotak Coba, dan contoh cURL. Menerbitkan endpoint tidak otomatis menerbitkan dokumentasinya — Anda yang memilih kapan membagikannya.

1. Terbitkan setidaknya satu endpoint, dan simpan semua perubahan. Sebelum itu, bilah Referensi API di bagian atas Admin›API bertuliskan Tidak diterbitkan dan menjelaskan apa yang masih kurang.

2. Klik Terbitkan dokumentasi.

   

3. Bilah kini bertuliskan Diterbitkan. Klik Salin tautan dokumentasi untuk membagikan alamatnya, atau Buka dokumentasi API di bawah Kunci API untuk melihat halamannya. Alamatnya seperti https://monstarx.com/api-docs/<your project id>.

monstarx.com

Halaman ini dibuka dengan nama dan deskripsi proyek Anda, jumlah endpoint yang dicantumkan, ID proyek, dan alamat dasarnya. Siapa pun yang punya tautannya bisa membacanya, dan mesin pencari diminta untuk tidak mengindeksnya. Halaman ini hanya menampilkan endpoint yang aktif dan tidak pernah menampilkan kunci. OpenAPI JSON di bagian atas menautkan ke deskripsi yang sama dalam bentuk file.

Untuk menurunkan dokumentasi, klik Batalkan penerbitan dokumentasi: halaman dan file OpenAPI-nya berhenti berfungsi, sementara endpoint Anda tetap menjawab. Jika Anda menonaktifkan semua endpoint, dokumentasinya juga ikut diturunkan, dan Anda bisa menerbitkannya lagi saat sudah siap.

Seperti apa permintaan dan jawabannya?

Setiap endpoint berada di bawah https://monstarx.com/api/rest/<your project id>, diikuti jalurnya.

Daftar

curl 'https://monstarx.com/api/rest/<project id>/recipes?page=1&limit=25'

{
  "data": [
    { "id": "41a6…", "title": "Street tacos al pastor", "country_code": "MX" }
  ],
  "page": 1,
  "limit": 25,
  "hasMore": false
}

limit bernilai 1 sampai 100 catatan per halaman (25 jika tidak diisi) dan page bernilai 1 sampai 100. hasMore menunjukkan apakah masih ada halaman berikutnya.

Buat

curl -X POST 'https://monstarx.com/api/rest/<project id>/recipes' \
  -H 'Authorization: Bearer YOUR_PROJECT_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title": "Lemon ricotta pancakes", "country_code": "IT"}'

Jawabannya (status 201) berisi catatan baru di bawah data beserta id-nya.

Perbarui dan hapus

curl -X PATCH 'https://monstarx.com/api/rest/<project id>/recipes/RECORD_ID' \
  -H 'Authorization: Bearer YOUR_PROJECT_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title": "Fluffy lemon ricotta pancakes"}'

curl -X DELETE 'https://monstarx.com/api/rest/<project id>/recipes/RECORD_ID' \
  -H 'Authorization: Bearer YOUR_PROJECT_KEY'

Perbarui menjawab dengan catatan yang sudah diubah; Hapus menjawab { "deleted": true }.

Aturan untuk data yang Anda kirim:

• Objek JSON dengan Content-Type: application/json, hingga 64 KB.
• Hanya kolom yang dapat diakses, masing-masing berupa nilai sederhana: teks (hingga 20.000 karakter), angka, true/false, atau null.
• ID tidak bisa diisi atau diubah, begitu pula kolom yang bersifat baca-saja di Admin.

Jika ada yang salah, jawabannya berisi pesan error dan sebuah status: 400 (permintaan tidak benar), 401 (diperlukan kunci API proyek yang valid), 403 (tabel atau tindakan itu tidak diizinkan di Admin), 404 (endpoint atau catatan tidak ada), 409 (terjadi konflik, misalnya duplikat), 413 (jawabannya akan melebihi 1 MB — kurangi kolom yang dapat diakses atau gunakan halaman yang lebih kecil).

Pertanyaan umum

Mengapa saya tidak bisa mengeklik Terbitkan dokumentasi?

Dokumentasi memerlukan setidaknya satu endpoint yang aktif dan tidak ada perubahan yang belum disimpan. Centang Terbitkan endpoint pada sebuah endpoint, klik Simpan & terbitkan endpoint, lalu Terbitkan dokumentasi.

Apakah saya perlu menerbitkan aplikasi agar API berfungsi?

Tidak. API membaca dan menulis langsung ke database proyek Anda, jadi API langsung berfungsi begitu sebuah endpoint diterbitkan. API memakai data yang sama dengan pratinjau dan aplikasi Anda yang aktif, serta tidak memerlukan proses membangun, AI, maupun kredit.

Bisakah sebuah situs web memanggil API saya dari browser?

Bisa, situs web mana pun bisa memanggil endpoint Anda. Gunakan endpoint dengan Akses baca publik dari halaman web, dan lakukan panggilan yang dilindungi kunci dari server agar kuncinya tetap rahasia.

Kunci API saya hilang. Bisakah saya melihatnya lagi?

Tidak, kunci hanya ditampilkan sekali. Buat kunci baru, alihkan layanan ke kunci itu, lalu Cabut kunci lama.

Mengapa saya tidak bisa menerbitkan endpoint?

Untuk Buat, Perbarui, atau Hapus, aktifkan dulu tindakan itu untuk tabelnya di Admin. Aplikasi yang database aktifnya berjalan di akun Cloudflare Anda sendiri tidak bisa menerbitkan endpoint dari MonstarX, karena database di sini berisi data latihan pratinjau.

Bisakah saya mendapat webhook saat data berubah?

Tidak dari Admin → API, yang hanya menjawab permintaan. Minta MonstarX menambahkan webhook ke aplikasi Anda — misalnya “saat ada pesanan masuk, kirim pesanan itu dengan POST ke alamat ini”.

Terkait

Panel admin aplikasi AndaTempat API berada, bersama tabel, pengguna, dan aktivitas Anda.

Database aplikasi AndaTabel yang dibaca dan ditulis oleh endpoint Anda.

Rahasia dan kunci APIKunci yang dipakai aplikasi Anda untuk layanan lain.

Gunakan MonstarX dari agen pemrograman AndaKendalikan MonstarX langsung dari Claude Code, Cursor, dan lainnya.