API dokümantasyonunuzu yazıp yayınlamaya hazırlandığınızda, önemli bir soru ortaya çıkar: Bunu kimler görüntüleyebilmeli?
Dokümanlar tamamen herkese açık mı olmalı? Yoksa sadece dahili ekibinize mi kısıtlanmalı? Belki harici ortaklarınızın erişime ihtiyacı var ama herkesin değil.
Her senaryo için dokümantasyonun ayrı bir versiyonunu oluşturmak zaman alıcı ve verimsiz olacaktır. Gerçekte, erişim ihtiyaçları genellikle oldukça spesifiktir; belki sadece bir departman görmeli veya ortaklarınız sadece kendi kurumsal ağlarından erişmelidir.
Neyse ki, Apidog tüm bu ihtiyaçları karşılamak için birden fazla erişim kontrol seçeneği sunar. Bir doküman sitesi yayınlarken, kullanım durumunuza uygun erişim kontrol yöntemini seçmeniz yeterlidir.
1. Herkese Açık: Herkes Görüntüleyebilir
API'niz ürününüzün açık API'si gibi herkese açık kullanıma açıksa, erişim kontrolünü "Herkese Açık" olarak ayarlamanız yeterlidir. Bağlantıya sahip herkes dokümantasyonu görüntüleyebilir.
İpucu: Apidog ayrıca geliştiricilerin API'leri tarayabileceği ve keşfedebileceği, pazar yeri tarzı bir platform olan bir API Hub'a da sahiptir. Görünürlüğü ve benimsenmeyi artırmak için dokümanlarınızı orada yayınlayın.
2. Parola Korumalı: Basit Bir Engel
Bazen dokümanlarınızın tamamen herkese açık olmasını istemezsiniz, ancak karmaşık kurulumdan da kaçınmak istersiniz. Parola koruması basit bir çözümdür; bir parola belirleyin ve yalnızca onu bilenler dokümanlara erişebilir.
Kurulumu kolaydır:
- "Parola Korumalı" seçeneğini belirleyin
- Parolayı manuel olarak ayarlayın veya sistemin oluşturmasına izin verin
- İş arkadaşlarınızla veya ortaklarınızla paylaşın
En iyisi: Bir ortağın API tasarımınızı incelemesine izin vermek gibi kısa süreli veya geçici paylaşımlar için. Daha sonra, parolayı güncelleyin veya dokümanların yayınını kaldırın. Basit ve temiz.
Ancak unutmayın: Parolalar istemeden paylaşılabilir. Daha sıkı bir kontrole ihtiyacınız varsa, diğer seçenekleri değerlendirin.
3. IP Beyaz Listesi: Erişimi Belirli Ağlarla Kısıtlama
Ekibiniz veya ortaklarınız sabit ofis konumlarındaysa, IP beyaz listesi en iyi seçiminiz olabilir.
Şöyle çalışır:
- Yalnızca belirtilen IP adreslerinden veya aralıklarından gelen kullanıcılar dokümanlara erişebilir
- Yetkisiz IP'ler otomatik olarak reddedilir
Bunu dokümantasyonunuz için bir güvenlik duvarı gibi düşünebilirsiniz.
En iyisi:
- Kurumsal ortamlar
- Dahili ağınıza erişimi kısıtlama
- Ortak erişimine yalnızca kendi ofis ağlarından izin verme
Tek bir IP veya tüm bir IP aralığını yapılandırabilirsiniz.
Bonus: Apidog'un Ekip Ayarları'nda (Kurumsal plan gereklidir) ekip proje erişimi için IP beyaz listesini de etkinleştirebilirsiniz. Etkinleştirildiğinde, yalnızca izin verilen IP'lerden gelen kullanıcılar dahili projelerinize erişebilir.
4. E-posta Beyaz Listesi: Kimlik Tabanlı Erişim
Parolaların sızdırılabileceğinden veya IP'lerin sık sık değişebileceğinden mi endişeleniyorsunuz? E-posta beyaz listesi esnek ve güvenli bir alternatiftir.
Ekibinizin veya ortaklarınızın e-posta adreslerini beyaz listeye eklemeniz yeterlidir. Kullanıcılar daha sonra tek kullanımlık bir e-posta doğrulama kodu aracılığıyla dokümanlara erişebilir.
Ayrıca joker karakterleri de destekler; örneğin, *@apidog.com şirketinizin alan adına sahip tüm kullanıcıların dokümantasyona erişmesine izin verir.
Faydaları:
- Yönetimi kolay: gerektiğinde kullanıcı ekleyip kaldırın
- Parolalardan daha güvenli: yetkisiz kullanıcılar bağlantıya sahip olsalar bile dokümanları görüntüleyemez
- Dağıtık ekipler veya mobil iş gücü için harika
5. Özel Giriş Sayfası: Kendi Kimlik Doğrulama Sisteminizle Entegre Edin
Yukarıdaki yöntemlerden hiçbiri ihtiyaçlarınızı karşılamıyorsa, daha gelişmiş bir seçenek var: Özel Giriş Sayfası. Bu, erişimi kontrol etmek için kendi kimlik doğrulama sisteminizi bağlamanıza olanak tanır.
Şöyle çalışır:
- Bir kullanıcı doküman sitesine erişmeye çalıştığında, giriş sayfanıza yönlendirilir.
- Kimlik doğrulamadan sonra sunucunuz bir JWT belirteci (token) oluşturur.
- Kullanıcı, belirteç bir parametre olarak doküman sitesine geri yönlendirilir.
- Apidog belirteci doğrular ve geçerliyse erişim izni verir.
Bu yaklaşım, izinleri iş ihtiyaçlarınıza tam olarak göre tanımlamanıza olanak tanır. Biraz geliştirme gerektirse de, karmaşık erişim kontrolü ihtiyaçları olan şirketler için harika bir çözümdür.
Özel bir giriş sayfası uygulamasının ayrıntıları için Yardım Dokümanlarını kontrol edin.
Doğru Erişim Kontrol Yöntemi Nasıl Seçilir?
Bu kadar çok seçenek varken merak edebilirsiniz: Hangisini seçmeliyim?
Kullanım durumunuza bağlıdır:
| Kullanım Durumu | Önerilen Yöntem |
|---|---|
| Herkese Açık API'ler, görünürlük isteniyor | Herkese Açık Erişim |
| Ekip çalışması veya kısa süreli harici paylaşım | Parola Koruması |
| Güvenli dahili veya ortak ağlar | IP Beyaz Listesi |
| Kullanıcı kimliğine göre erişimi kontrol etme | E-posta Beyaz Listesi |
| Kendi giriş sisteminizi kullanma | Özel Giriş Sayfası |
İpucu: Birden fazla yöntemi birleştirebilirsiniz. Örneğin:
- Dahili ekip üyeleri için bir IP beyaz listesi kullanın
- Harici ortaklar için bir e-posta beyaz listesi kullanın
- Geçici demolar için parola koruması kullanın
Apidog ile, her biri kendi erişim kontrolüne ve özel olarak hazırlanmış API uç noktalarına sahip birden fazla doküman sitesi yayınlayabilirsiniz. Bu, farklı kitlelerin yalnızca ihtiyaç duyduklarını görmesi anlamına gelir—ne eksik ne fazla.