REST API dan webhook sudah tersedia
Buat kode QR dan tautan pendek dari sistem Anda dengan kunci dan cakupan API.
- Kunci memakai awalan qrw_live_
- 300 permintaan per menit per kunci
- Webhook untuk perubahan tautan
curl -X POST https://app.smartqrcodes.io/api/v1/qr-codes \ -H "Authorization: Bearer qrw_live_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "title": "Autumn menu", "type": "URL", "content": "https://cafe.example/menu", "isDynamic": true, "slug": "autumn" }'→ 201 Created{ "id": "8b1e27d3-2b57-4b6f-b6c4-a9f6cf79ea31", "shortLink": { "slug": "autumn" }, "isActive": true }
Kunci API dibatasi oleh izin yang dipilih. Simpan rahasia lengkap saat kunci diterbitkan.
Ketersediaan fitur
Apa yang berfungsi sekarang
/api/v1 menggunakan kunci API qrw_live_… dengan autentikasi Bearer dan scope. Batasnya 300 permintaan per menit untuk setiap kunci.
Kunci memakai awalan qrw_live_
Rahasia lengkap hanya ditampilkan saat kunci dibuat atau dirotasi. Segera simpan di penyimpanan yang aman, dan jika rahasia hilang, rotasi kunci.
300 permintaan per menit per kunci
Scope kunci API menentukan sumber daya dan operasi yang tersedia. Setiap permintaan diperiksa secara terpisah.
Webhook untuk perubahan tautan
Buat kode QR dan tautan pendek dari sistem Anda dengan kunci dan cakupan API.
Apa yang tersedia lewat API saat ini
Scope kunci API menentukan sumber daya dan operasi yang tersedia. Setiap permintaan diperiksa secara terpisah.
Autentikasi berbasis scope
Kirim kunci sebagai Authorization: Bearer qrw_live_…; aksesnya hanya mencakup sumber daya dan operasi yang diizinkan.
Situs mini dan proyek
Scope read/write yang terpisah memungkinkan integrasi diberi hak seperlunya saja.
Isolasi permintaan
Setiap permintaan diotorisasi secara terpisah berdasarkan kunci API dan scope-nya.
Siklus hidup kunci
Kunci bisa dibuat, diatur, dirotasi, dan dicabut; rahasia lengkapnya tidak dikembalikan di daftar kunci.
Batas dokumentasi
Referensi rute dan contoh permintaan tersedia di dasbor Anda; file OpenAPI, SDK resmi, dan pustaka klien belum dipublikasikan.
Rahasia kunci hanya ditampilkan sekali
Rotasi mencabut kunci sebelumnya dan menerbitkan penggantinya, sedangkan pencabutan menghentikan otorisasi lebih lanjut dengan kunci tersebut.
Autentikasi Bearer dengan kunci API
Kirim kunci berawalan qrw_live_… di header Authorization: Bearer. Scope membatasi operasi yang tersedia dan setiap kunci dibatasi hingga 300 permintaan per menit.
- Pembuatan, peninjauan, dan pengaturan kunci API
- Rotasi dan pencabutan kunci
- Rahasia lengkap ditampilkan satu kali
- Authorization: Bearer qrw_live_…
Authorization: Bearer qrw_live_YOUR_KEY
Rahasia lengkap hanya ditampilkan saat kunci dibuat atau dirotasi. Segera simpan di penyimpanan yang aman, dan jika rahasia hilang, rotasi kunci.
Kontrak permintaan API
Tabel ini memuat parameter wajib dari API eksternal saat ini.
| Kontrak permintaan API | Persyaratan | API saat ini |
|---|---|---|
| Autentikasi | Kunci API | Bearer qrw_live_… |
| Header | Authorization | Bearer qrw_live_… |
| Kontrol akses | Scope kunci API | Diperiksa pada setiap permintaan |
| Batas permintaan | Per kunci API | 300 permintaan per menit |
- Autentikasi
- Persyaratan
- Kunci API
- API saat ini
- Bearer qrw_live_…
- Header
- Persyaratan
- Authorization
- API saat ini
- Bearer qrw_live_…
- Kontrol akses
- Persyaratan
- Scope kunci API
- API saat ini
- Diperiksa pada setiap permintaan
- Batas permintaan
- Persyaratan
- Per kunci API
- API saat ini
- 300 permintaan per menit
Mulai cepat
Cara menghubungkan integrasi sisi server
Buat kunci dengan hak seminimal mungkin, simpan rahasia yang hanya ditampilkan sekali, dan kirimkan hanya dari lingkungan tepercaya.
- 1
Buat kuncinya
Dapatkan kunci untuk integrasi server, tetapkan scope minimum yang diperlukan, lalu simpan rahasianya di lokasi terlindungi.
- 2
Pilih scope-nya
Sisakan hanya hak baca dan tulis yang benar-benar dibutuhkan integrasi tersebut.
- 3
Simpan rahasianya
Salin rahasianya saat itu juga: nilainya tidak ditampilkan lagi. Bila hilang, lakukan rotasi.
- 4
Kirimkan headernya
Gunakan Authorization: Bearer qrw_live_… pada rute /api/v1 yang didukung.
FAQ
Pertanyaan umum
Seperti apa format kunci API?
Kunci diawali qrw_live_…. Simpan rahasia lengkap di lingkungan server yang terlindungi dan jangan tampilkan dalam kode klien.
Bagaimana cara mengirim kunci API?
Kirim kunci di header Authorization sebagai kredensial Bearer atau di header X-API-Key. Akses dibatasi oleh scope kunci.
Berapa batas permintaannya?
Setiap kunci API dibatasi hingga 300 permintaan per menit.
Peristiwa apa yang dikirim webhook?
Webhook dikirim saat tautan pendek dibuat, diperbarui, atau dihapus: link.created, link.updated, dan link.deleted.
Buat kunci untuk integrasi sisi server
Pilih scope seminimal mungkin, simpan rahasianya saat diterbitkan, dan gunakan hanya di lingkungan tepercaya.