Setelah menulis dokumentasi API Anda dan bersiap untuk memublikasikannya, muncul pertanyaan kunci: Siapa yang seharusnya dapat melihatnya?
Haruskah dokumen tersebut sepenuhnya publik? Atau dibatasi untuk tim internal Anda? Mungkin mitra eksternal Anda memerlukan akses—tetapi tidak sembarang orang.
Membuat versi dokumentasi terpisah untuk setiap skenario akan memakan waktu dan tidak efisien. Pada kenyataannya, kebutuhan akses seringkali sangat spesifik—mungkin hanya satu departemen yang boleh melihatnya, atau mungkin mitra Anda hanya boleh mengaksesnya dari dalam jaringan perusahaan mereka.
Untungnya, Apidog menyediakan berbagai opsi kontrol akses untuk memenuhi semua kebutuhan ini. Saat memublikasikan situs dokumen, cukup pilih metode kontrol akses yang sesuai dengan kasus penggunaan Anda.
1. Publik: Siapa Saja Dapat Melihat
Jika API Anda terbuka untuk penggunaan publik—seperti API terbuka produk Anda—cukup atur kontrol akses ke "Publik". Siapa pun yang memiliki tautan dapat melihat dokumentasi tersebut.
Tips pro: Apidog juga memiliki API Hub, platform bergaya marketplace tempat pengembang dapat menelusuri dan menemukan API. Publikasikan dokumen Anda di sana untuk meningkatkan visibilitas dan adopsi.
2. Dilindungi Kata Sandi: Penghalang Sederhana
Terkadang Anda tidak ingin dokumen Anda sepenuhnya publik, tetapi Anda juga ingin menghindari pengaturan yang rumit. Perlindungan kata sandi adalah solusi langsung—atur kata sandi, dan hanya mereka yang mengetahuinya yang dapat mengakses dokumen.
Pengaturan mudah:
- Pilih “Dilindungi Kata Sandi”
- Atur kata sandi secara manual atau biarkan sistem membuatnya
- Bagikan dengan rekan kerja atau mitra
Terbaik untuk: Berbagi jangka pendek atau sementara, seperti membiarkan mitra meninjau desain API Anda. Setelah itu, cukup perbarui kata sandi atau batalkan publikasi dokumen. Sederhana dan bersih.
Namun perlu diingat: Kata sandi dapat dibagikan secara tidak sengaja. Jika Anda memerlukan kontrol yang lebih ketat, pertimbangkan opsi lain.
3. Daftar Putih IP: Batasi Akses ke Jaringan Tertentu
Jika tim atau mitra Anda berbasis di lokasi kantor tetap, daftar putih IP mungkin menjadi pilihan terbaik Anda.
Cara kerjanya seperti ini:
- Hanya pengguna dari alamat IP atau rentang yang ditentukan yang dapat mengakses dokumen
- IP yang tidak sah secara otomatis ditolak
Anggap saja sebagai firewall untuk dokumentasi Anda.
Terbaik untuk:
- Lingkungan korporat
- Membatasi akses ke jaringan internal Anda
- Mengizinkan akses mitra hanya dari jaringan kantor mereka
Anda dapat mengonfigurasi satu IP atau seluruh rentang IP.
Bonus: Anda juga dapat mengaktifkan daftar putih IP untuk akses proyek tim di Pengaturan Tim Apidog (diperlukan paket Enterprise). Setelah diaktifkan, hanya pengguna dari IP yang diizinkan yang dapat mengakses proyek internal Anda.
4. Daftar Putih Email: Akses Berbasis Identitas
Khawatir kata sandi bocor atau IP sering berubah? Daftar putih email adalah alternatif yang fleksibel dan aman.
Cukup tambahkan alamat email tim atau mitra Anda ke daftar putih. Pengguna kemudian dapat mengakses dokumen melalui kode verifikasi email satu kali.
Ini juga mendukung wildcard—misalnya, *@apidog.com mengizinkan semua pengguna dengan domain perusahaan Anda untuk mengakses dokumentasi.
Manfaat:
- Mudah dikelola: tambah atau hapus pengguna sesuai kebutuhan
- Lebih aman daripada kata sandi: pengguna yang tidak sah tidak dapat melihat dokumen meskipun mereka memiliki tautan
- Sangat baik untuk tim terdistribusi atau tenaga kerja mobile
5. Halaman Login Kustom: Integrasikan dengan Sistem Otentikasi Anda Sendiri
Jika tidak ada metode di atas yang memenuhi kebutuhan Anda, ada opsi yang lebih canggih—Halaman Login Kustom. Ini memungkinkan Anda menghubungkan sistem otentikasi Anda sendiri untuk mengontrol akses.
Begini cara kerjanya:
- Ketika pengguna mencoba mengakses situs dokumen, mereka akan dialihkan ke halaman login Anda.
- Setelah otentikasi, server Anda menghasilkan token JWT.
- Pengguna dialihkan kembali ke situs dokumen dengan token sebagai parameter.
- Apidog memverifikasi token, dan memberikan akses jika valid.
Pendekatan ini memungkinkan Anda mendefinisikan izin persis seperti yang dibutuhkan bisnis Anda. Meskipun memerlukan beberapa pengembangan, ini sangat cocok untuk perusahaan dengan kebutuhan kontrol akses yang kompleks.
Periksa Dokumen Bantuan untuk detail tentang penerapan halaman login kustom.
Bagaimana Memilih Metode Kontrol Akses yang Tepat
Dengan begitu banyak pilihan, Anda mungkin bertanya-tanya: Mana yang harus saya pilih?
Itu tergantung pada kasus penggunaan Anda:
| Kasus Penggunaan | Metode yang Direkomendasikan |
|---|---|
| API Publik, ingin eksposur | Akses Publik |
| Kerja tim atau berbagi eksternal jangka pendek | Perlindungan Kata Sandi |
| Jaringan internal atau mitra yang aman | Daftar Putih IP |
| Kontrol akses berdasarkan identitas pengguna | Daftar Putih Email |
| Gunakan sistem login Anda sendiri | Halaman Login Kustom |
Tips: Anda dapat menggabungkan beberapa metode. Contohnya:
- Gunakan daftar putih IP untuk anggota tim internal
- Gunakan daftar putih email untuk mitra eksternal
- Gunakan perlindungan kata sandi untuk demo sementara
Dengan Apidog, Anda dapat memublikasikan beberapa situs dokumen, masing-masing dengan kontrol aksesnya sendiri dan set endpoint API yang disesuaikan. Itu berarti audiens yang berbeda hanya melihat apa yang mereka butuhkan—tidak lebih, tidak kurang.