REST API dan dokumentasi API aplikasi anda

Q: Mengapakah saya tidak dapat menerbitkan titik akhir?

Bagi Cipta, Kemas kini atau Padam, hidupkan tindakan itu untuk jadual tersebut dalam Admin terlebih dahulu. Aplikasi yang pangkalan data langsungnya berjalan pada akaun Cloudflare anda sendiri tidak boleh menerbitkan titik akhir daripada MonstarX, kerana pangkalan data di sini menyimpan data latihan pratonton.

RingkasnyaDalam tab Admin, API menukar jadual aplikasi anda menjadi titik akhir REST yang boleh dipanggil oleh perisian lain — senaraikan, dapatkan, cipta, kemas kini atau padam rekod. Anda memilih jadual, medan dan siapa yang boleh memanggilnya (sesiapa sahaja untuk membaca, atau hanya pemanggil yang mempunyai kunci API projek), kemudian menghidupkannya dengan Terbitkan titik akhir. Apabila anda mahu berkongsi, klik Terbitkan dokumentasi untuk menyiarkan halaman rujukan API dan fail OpenAPI untuk pembangun.

Kadangkala perisian lain memerlukan data aplikasi anda: laman web rakan niaga yang menyenaraikan produk anda, hamparan yang menarik masuk pesanan baharu, aplikasi mudah alih, alat automasi seperti Zapier atau n8n. Perisian itu berkomunikasi dengan aplikasi anda melalui API — satu set alamat web (titik akhir atau endpoint) yang menjawab dengan data dan bukannya halaman. REST API ialah jenis yang paling biasa.

MonstarX membuatnya untuk anda tanpa kod. Anda memilih apa yang hendak dikongsi, dan ia aktif dalam beberapa saat, berserta halaman rujukan yang boleh dibaca oleh pembangun.

Di manakah saya boleh menemuinya?

Buka projek anda, klik Admin di bar atas, kemudian API dalam bar sisi Admin. Anda melihat API projek: di bahagian atas, bar Rujukan API yang menerbitkan dokumentasi API anda; titik akhir anda di sebelah kiri, masing-masing ditanda Aktif atau Draf; dan Kunci API di bawahnya.

Admin, API untuk aplikasi Nota Dapur: bar Rujukan API ditanda Diterbitkan dengan Titik akhir aktif: 1, dan titik akhir aktif GET /recipes bernama Senaraikan Resipi, dengan nama, laluan, koleksi dan operasinya

Bagaimanakah saya mencipta titik akhir?

Dalam AdminAPI, klik Titik akhir baharu (atau + di sebelah Titik akhir).
Pilih Koleksi — jadual yang digunakan oleh titik akhir itu, seperti jadual resipi.

Pilih Operasi:

Operasi	Kaedah dan alamat	Fungsinya
Senaraikan	`GET /recipes`	Memulangkan rekod, satu halaman pada satu masa.
Dapatkan	`GET /recipes/{id}`	Memulangkan satu rekod mengikut idnya.
Cipta	`POST /recipes`	Menambah rekod.
Kemas kini	`PATCH /recipes/{id}`	Mengubah beberapa medan sesuatu rekod.
Padam	`DELETE /recipes/{id}`	Mengalih keluar rekod.

Beri titik akhir itu Nama, Laluan URL dan, jika mahu, Penerangan. Semuanya muncul dalam dokumentasi API.
Di bawah Medan yang boleh diakses, tandakan hanya medan yang boleh dilihat atau dihantar oleh pemanggil. Medan yang tidak ditandakan kekal tersembunyi. Medan yang kelihatan sensitif, seperti kata laluan dan token, sentiasa dikecualikan.
Di bawah Akses, pilih siapa yang boleh memanggilnya (lihat di bawah).
Tandakan Terbitkan titik akhir dan klik Simpan & terbitkan titik akhir. Titik akhir yang diterbitkan berstatus Aktif: ia menjawab permintaan serta-merta. Jika kotak itu tidak ditandakan, Simpan titik akhir menyimpannya sebagai Draf.

Dalam senarai, setiap titik akhir menunjukkan Aktif atau Draf. Perkataan yang sama dipaparkan di bawah Sunting titik akhir, diikuti Perubahan yang tidak disimpan sehingga anda menyimpan. Nyahtanda Terbitkan titik akhir dan simpan untuk mengeluarkannya daripada talian tanpa memadamnya; Padam mengalih keluarnya.

Siapakah yang boleh memanggil titik akhir saya?

Akses	Siapa yang boleh memanggilnya	Dibenarkan untuk
Bacaan umum	Sesiapa sahaja yang mempunyai alamatnya.	Senaraikan dan Dapatkan sahaja
Kunci API projek	Hanya pemanggil yang menghantar salah satu kunci API projek anda.	Setiap operasi

Titik akhir yang mengubah data sentiasa memerlukan kunci.

Bagaimanakah saya mencipta kunci API?

Dalam AdminAPI, klik Kunci API.
Taip nama yang menunjukkan tempat kunci itu akan digunakan, seperti “Pelayan widget resipi”, dan klik Cipta kunci.
Salin kunci itu serta-merta — ia bermula dengan mxapi_ dan tidak boleh ditunjukkan lagi. Simpan di tempat yang selamat, seperti pengurus kata laluan atau bahagian rahsia perkhidmatan yang satu lagi.

Kunci API projek: nama kunci telah ditaip dan butang Cipta kunci, dengan nota bahawa kunci memberikan akses kepada setiap titik akhir yang dilindungi kunci dan setiap kunci ditunjukkan sekali sahaja

Satu kunci membuka setiap titik akhir yang dilindungi kunci dalam projek, jadi beri setiap perkhidmatan kuncinya sendiri. Klik Tarik balik untuk mematikan kunci; apa-apa yang menggunakannya berhenti berfungsi serta-merta.

Pemanggil menghantar kunci dalam pengepala Authorization: Authorization: Bearer mxapi_….

Bagaimanakah saya mencuba titik akhir?

Buka titik akhir itu dan klik Ujian. Masukkan ID rekod, Kunci Bearer atau Kandungan JSON jika titik akhir itu memerlukannya, dan klik Hantar permintaan. Anda melihat status (200 bermaksud berjaya), tempoh masa yang diambil dan jawapannya. Bagi titik akhir yang memerlukan kunci, tampal salah satu kunci anda daripada Kunci API ke dalam Kunci Bearer.

Ujian dihantar ke titik akhir sebenar yang aktif, jadi:

Draf belum boleh diuji. Tab Ujian memaparkan Titik akhir ini ialah draf; klik Simpan & terbitkan titik akhir di situ untuk menerbitkan dan mengujinya.
Simpan perubahan anda dahulu. Jika ada perubahan yang belum disimpan, tab Ujian meminta anda menyimpan sebelum menguji, dengan butang Simpan titik akhir.

Tab Ujian bagi GET /recipes: alamat penuh pada monstarx.com, butang Hantar permintaan, dan jawapan 200 yang menyenaraikan resipi dalam JSON

Ujian bagi Cipta, Kemas kini atau Padam mengubah data sebenar anda.

Tab Kod menyediakan arahan cURL siap sedia untuk disalin, dan fail OpenAPI JSON yang boleh diimport oleh alat API seperti Postman dan Insomnia.

Tab Kod: arahan cURL bagi GET /recipes dengan butang Salin, dan pautan ke fail OpenAPI JSON

Bagaimanakah saya menerbitkan dan berkongsi dokumentasi API saya?

Dokumentasi API anda ialah halaman Rujukan API untuk pembangun: setiap titik akhir yang aktif, medannya, sama ada ia memerlukan kunci, kotak Cubalah dan contoh cURL. Menerbitkan titik akhir tidak menerbitkan dokumentasi — anda yang memilih bila hendak berkongsinya.

Terbitkan sekurang-kurangnya satu titik akhir, dan simpan sebarang perubahan. Sehingga itu, bar Rujukan API di bahagian atas AdminAPI memaparkan Tidak diterbitkan dan memberitahu anda apa yang masih kurang.
Klik Terbitkan dokumentasi.
Bar itu kini memaparkan Diterbitkan. Klik Salin pautan dokumentasi untuk berkongsi alamatnya, atau Buka dokumentasi API di bawah Kunci API untuk melihat halaman itu. Alamatnya kelihatan seperti https://monstarx.com/api-docs/<your project id>.

Rujukan API yang diterbitkan untuk aplikasi Nota Dapur: nama dan penerangan projek, Titik akhir: 1, ID projek dan alamat asasnya, serta GET /recipes dengan Bacaan umum, medannya yang boleh diakses dan kotak Cubalah yang memulangkan resipi dalam JSON

Halaman itu dibuka dengan nama dan penerangan projek anda, bilangan titik akhir yang disenaraikan, ID projek dan alamat asas. Sesiapa sahaja yang mempunyai pautan boleh membacanya, dan enjin carian diberitahu supaya tidak mengindeksnya. Ia hanya memaparkan titik akhir yang aktif dan tidak sekali-kali memaparkan kunci. OpenAPI JSON di bahagian atas memautkan kepada penerangan yang sama dalam bentuk fail.

Untuk menurunkan dokumentasi, klik Nyahterbitkan dokumentasi: halaman itu dan fail OpenAPI-nya berhenti berfungsi, manakala titik akhir anda terus menjawab. Jika anda mengeluarkan setiap titik akhir daripada talian, dokumentasi turut dinyahterbitkan, dan anda menerbitkannya semula apabila bersedia.

Bagaimanakah rupa permintaan dan jawapan?

Setiap titik akhir berada di bawah https://monstarx.com/api/rest/<your project id>, diikuti oleh laluannya.

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 ialah 1 hingga 100 rekod bagi setiap halaman (25 jika anda tidak menyatakannya) dan page ialah 1 hingga 100. hasMore menunjukkan sama ada terdapat halaman seterusnya.

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"}'

Jawapannya (status 201) mengandungi rekod baharu di bawah data beserta idnya.

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'

Kemas kini menjawab dengan rekod yang telah diubah; Padam menjawab { "deleted": true }.

Peraturan untuk apa yang anda hantar:

Objek JSON dengan Content-Type: application/json, sehingga 64 KB.
Hanya medan yang boleh diakses, setiap satu nilai biasa: teks (sehingga 20,000 aksara), nombor, true/false atau null.
Id tidak boleh ditetapkan atau diubah, begitu juga medan yang baca sahaja dalam Admin.

Apabila ada masalah, jawapannya mengandungi mesej error dan status: 400 (permintaan tidak betul), 401 (kunci API projek yang sah diperlukan), 403 (jadual atau tindakan itu tidak dibenarkan dalam Admin), 404 (titik akhir atau rekod itu tidak wujud), 409 (konflik, seperti pendua), 413 (jawapan akan melebihi 1 MB — dedahkan lebih sedikit medan atau gunakan halaman yang lebih kecil).

Soalan lazim

Mengapakah saya tidak dapat mengklik Terbitkan dokumentasi?

Dokumentasi memerlukan sekurang-kurangnya satu titik akhir yang aktif dan tiada perubahan yang belum disimpan. Tandakan Terbitkan titik akhir pada sesuatu titik akhir, klik Simpan & terbitkan titik akhir, kemudian Terbitkan dokumentasi.

Perlukah saya menerbitkan aplikasi saya supaya API berfungsi?

Tidak. API membaca dan menulis pangkalan data projek anda secara terus, jadi ia berfungsi sebaik sahaja titik akhir diterbitkan. Ia menggunakan data yang sama seperti pratonton dan aplikasi anda yang sedang berjalan, dan tidak memerlukan binaan, AI atau kredit.

Bolehkah laman web memanggil API saya daripada pelayar?

Boleh, mana-mana laman web boleh memanggil titik akhir anda. Gunakan titik akhir Bacaan umum daripada halaman web, dan simpan panggilan yang dilindungi kunci pada pelayan supaya kunci itu kekal rahsia.

Saya kehilangan kunci API. Bolehkah saya melihatnya semula?

Tidak, kunci hanya ditunjukkan sekali. Cipta kunci baharu, tukar perkhidmatan itu supaya menggunakannya, kemudian Tarik balik kunci lama.

Mengapakah saya tidak dapat menerbitkan titik akhir?

Bagi Cipta, Kemas kini atau Padam, hidupkan tindakan itu untuk jadual tersebut dalam Admin terlebih dahulu. Aplikasi yang pangkalan data langsungnya berjalan pada akaun Cloudflare anda sendiri tidak boleh menerbitkan titik akhir daripada MonstarX, kerana pangkalan data di sini menyimpan data latihan pratonton.

Bolehkah saya menerima webhook apabila data berubah?

Tidak daripada Admin → API, yang hanya menjawab permintaan. Minta MonstarX menambah webhook pada aplikasi anda — contohnya “apabila pesanan dibuat, POST pesanan itu ke alamat ini”.

Berkaitan

Panel Admin aplikasi andaTempat API berada, bersama jadual, pengguna dan aktiviti anda.

Pangkalan data aplikasi andaJadual yang dibaca dan ditulis oleh titik akhir anda.

Rahsia dan kunci APIKunci yang digunakan oleh aplikasi anda untuk perkhidmatan lain.

Gunakan MonstarX daripada ejen pengekodan andaKendalikan MonstarX sendiri daripada Claude Code, Cursor dan lain-lain.