Menghubungkan alat Anda dengan API
API memungkinkan aplikasi pihak ketiga mengakses data Organisasi Anda secara terprogram: data anggota, kalender, Booking, dan penagihan. API diaktifkan dengan dua klik dan dilindungi oleh sebuah kunci, daftar alamat yang diizinkan, serta pemantauan penggunaan.
Mengetahui apakah API relevan bagi Anda
API ditujukan untuk pengembang, bukan untuk pengelola Organisasi. Fungsinya adalah menghubungkan akun Anda dengan perangkat lunak yang Anda buat atau atur sendiri: situs web khusus, alat akuntansi, layar informasi buatan sendiri, atau jembatan ke sistem lain.
Untuk kebutuhan sehari-hari — mengambil daftar Member, memperbarui Subscription secara massal, mengirimkan angka ke pengurus — modul impor, ekspor, dan laporan sudah mencukupi tanpa menulis satu baris kode.
API ditawarkan dalam versi beta: cara kerjanya masih dapat berubah.
Mengaktifkan API dan mengambil kunci Anda
- Buka Administrasi›Pengaturan›API BETA.
- Aktifkan Aktifkan modul API lalu klik Simpan.
- Kunci API Anda akan ditampilkan: salin dengan tombol Salin dan berikan hanya kepada alat yang Anda hubungkan.
Kunci dikirimkan melalui header HTTP X-API-Key pada setiap permintaan. Semua panggilan wajib menggunakan HTTPS; permintaan yang tidak terenkripsi tidak akan diterima.
Melindungi kunci
Beberapa kebiasaan berikut perlu diingatkan kepada alat atau penyedia jasa yang menggunakannya:
- jangan pernah menyimpan kunci di dalam repositori kode; simpanlah dalam berkas konfigurasi di luar repositori atau dalam pengelola rahasia;
- batasi alamat yang diizinkan segera setelah alat tersebut memanggil dari server tetap;
- buat ulang kunci pada keraguan sekecil apa pun — publikasi tidak sengaja, kebocoran log, berakhirnya kerja sama dengan penyedia jasa.
Tombol Regenerasi meminta konfirmasi, lalu langsung membatalkan kunci lama. Semua aplikasi yang memakainya akan berhenti berfungsi sampai menerima kunci yang baru: beri tahu mereka sebelum Anda mengklik.
Membatasi akses berdasarkan alamat IP
Aktifkan Pembatasan berdasarkan alamat IP: hanya permintaan yang berasal dari alamat yang Anda daftarkan akan diterima, dengan batas 10 alamat IPv4. Masukkan setiap alamat lalu konfirmasi dengan Tambah; alamat Anda saat ini ditampilkan di layar untuk membantu Anda.
Inilah perlindungan yang paling efektif, dan paling sering diabaikan: meski bocor, kunci yang dibatasi pada alamat penyedia jasa Anda tetap tidak dapat digunakan di tempat lain.
Memantau penggunaan
Layar ini menampilkan secara terus-menerus apa yang dikonsumsi oleh kunci Anda:
- Penggunaan menit ini dan Penggunaan hari ini, masing-masing dibandingkan dengan batasnya bila sebuah batas dikonfigurasi;
- Statistik Penggunaan: Minggu ini, Bulan ini, Total, dan Permintaan terakhir.
Di luar batas yang ditunjukkan, permintaan tambahan akan ditolak sementara. Penghitung yang terus-menerus mendekati batasnya biasanya menandakan alat yang tidak diatur dengan baik, yang meminta ulang data yang sama berulang kali alih-alih menyimpannya dalam cache.
Tanggal permintaan terakhir berguna dari sisi sebaliknya: kunci yang aktif tetapi tidak pernah dipanggil selama berbulan-bulan adalah kunci yang sebaiknya dinonaktifkan.
Mengetahui apa saja yang bisa dilakukan API
Dokumentasi lengkap, beserta parameter dan contoh pemanggilan, ditampilkan di bagian bawah layar modul. Secara garis besar:
- User: ini satu-satunya sumber daya yang dapat diubah. Anda dapat menampilkan daftar, melihat, membuat, mengubah, dan menghapus akun.
- Konfigurasi: Subscription, profil, grup, dan kategori usia dapat dilihat, tetapi hanya dapat dikonfigurasi dari aplikasi.
- Booking: kalender, Time Slot yang tersedia, Booking, dan Label dapat dilihat.
- Penagihan: Billing account, Order, dan pembayaran dapat dilihat.
