API Portal üzerinden yayınlanan API Product’ları yapılan ayarlara göre görüntüleyebilir, test edebilir kaydolarak kullanmaya başlayabilirsiniz. Bunun için ise bir API Portal Developer hesabına ihtiyaç vardır.
Bu dokümanda bir API Developer hesabı nasıl açılır ve yayınlanmış bir API Product
- Nasıl görüntülenir?
- Nasıl test edilir?
- Nasıl kullanmaya başlanılır ?
konularına değinilecektir.
API Developer hesabı oluşturup kullanmaya başlamak için ilgili API Portal adresine tarayıcı üzerinden gitmek gerekiyor. Bu bölümde anlatım ve örneklendirmeler Apinizer API Portal üzerinden gerçekleştirilecektir.
API Developer Hesabı Oluşturma
Yeni bir API Developer hesabı oluşturmak için sağ üstte bulunan kayıt ol butonuna tıklayabilir, eğer hesabınız varsa giriş butonuna tıklayarak giriş yapabilirsiniz.
İlgili alanları doldurduktan sonra kayıt ol butonuna basarak kayıt olma işleminizi gerçekleştirebilirsiniz.
Eğer API Portal yapılandırmasında otomatik kullanıcı kayıt isteği onaylama seçeneği API Portal sahibince aktif edilmezse giriş yapabilmek için API Portal sahibinin kayıt isteğini onaylaması gerekmektedir.
Bu sayfadan API’leri isimlerine ve kategorilerine göre filtreleyerek istediğiniz API’lere daha kolay erişebilir, ilgili API’nin detayına giderek detaylarına erişebilir, API Product tanımında test istekleri atmaya izin veriliyorsa test edebilir, kullanımları ve kabul ettiği istekler hakkında bilgi edinebilirsiniz.
İncelenmek istenen API’nin detay sayfasına geçtiğinizde genel bakış sayfası sizleri karşılıyor olacak, bu sayfadaki alanları inceleyecek olursak;
Uygulamalarım, API’ye kaydedilmiş uygulamalar, API’nin tanımlı client’ıdır. API tarafından client’ın tanımlanması ve yetkilendirmesi açısından önemli bir yapı taşıdır.
Dökümanlar, API’nin dökümanları ve API ile ilgili verileni, paylaşılmak istenen belgelerin listelendiği alandır. Yüklenmiş belgeleri indirebilir ve inceleyebilirsiniz.
İletişim bilgileri, ilgili API’den sorumlu kurum, birim, kişi veya kişilerin iletişim bilgilerini barındırır.
Plan, Uygulamaya kayıt olduğunuz plan seçeneğini gösterir.
Genel bakış sayfası altından ilgili API ile ilgili fikir edinebilir, API’nin kullanım amaçları hakkında bilgi sahibi olabilir ve dökümantasyon & test sayfasında endpointlerin istek yapısını öğrenebilirsiniz.
Dene butonuna bastıktan sonra açılan sayfada gerekli parametreleri, body’i girerek gönder butonuna basarak isteğinizi API’ye gönderebilirsiniz.
Eğer bir güvenlik politikasıyla korunan bir API’ye istek atıyorsanız öncesinde bir uygulama oluşturmalı, API kullanımı ve testi için uygulamayı API’ye oluşturduğumuz uygulamanın kaydını yapmalı, test aşamasında ise yetkilendirme yaparak API Endpointlerini test etmeliyiz. Aksi takdirde aşağıdaki hata ile karşılaşırız.
Uygulama Oluşturma ve Uygulamayı API’ye Kaydetme
Uygulama oluşturmak için sağ üst köşede bulunan uygulamalarım menüsüne tıklayarak uygulama oluşturma sayfasına gitmemiz gerekmektedir. Bu sayfa içerisinden kayıtlı uygulamalarınızı görüntüleyebilir, düzenleyebilir, silebilir veya bir yenisini ekleyebiliriz.
Uygulamalarım sayfasına gittikten sonra sağ üst köşede bulunan oluştur butonunu tetikleyerek açılan popup’ta yeni bir uygulama kaydı oluşturulabilinir.
Burada kaydet butonuna bastıktan sonra uygulama kaydı yapılmış olacaktır.
Uygulamayı oluşturduktan sonra bu uygulamanın kullanılmak istenilen API’lerden kayıt başvurulması yapılması gerekmektedir. Bunun için ise test edilmek istenilen API Product’ın detayına giderek detay sayfası içerisindeki uygulamalarım sekmesi açılır.
Bir API Product’a yeni bir uygulama kaydetmek için uygulamalarım sayfası altında bulunan ”+” butonuna basarak ilgili API’nin planlarından birine seçtiğiniz uygulamayı ekleme isteği gönderebilirsiniz.
Açılan popup’ta oluşturmuş olduğunuz uygulamanızı ve API Product’ın sahibi tarafından oluşturulmuş planlardan isteğinize uygun olanı seçilip kaydet butonuna basıldığı zaman API Product için uygulama kayıt isteği göndermiş oluruz.
API Product, uygulama kayıt istekleri API Product yayınlanma ayarına göre otomatik kabul edilebilir ya da API sorumluları tarafından elle onaylanıyor olabilir. Bu yüzden istek atabilmek için uygulama kayıt isteğinizin onaylanmasını beklemeniz gerekebilir.
Uygulama Kaydı Yapıldıktan Sonra Uygulama Yetkilendirme Ve Test İsteği Gönderme
Uygulama kaydı başarıyla tamamlandıktan sonra kaydı yapılan uygulama artık ilgili API Product’ı sahip olduğu plan kapsamında kullanmaya yetkilendirilmiş olacaktır.
Uygulama kaydı yapıldıktan sonra test isteği atarak API Product’ı denemek için ilgili API detayına gidilir ve Döküman & Test sekmesine geçiş yapılır.
Başarılı istek atabilmek ve Authentication politikalarından başarıyla geçebilmek için yetkilendir butonuna tıklanır.
Açılan popup’ta yetkilendirilecek uygulama seçildikten sonra yetkilendir butonuna tıklayarak yetkilendirme işlemi gerçekleştirilir. Bu sayede uygulama kaydı için arka planda otomatik olarak API Product tarafından beklenen Authentication bilgileri isteğe eklenerek yetkilendirme yapılması sağlanır.
Daha sonrasında denemek istediğimiz endpoint’e istek atarak test edebilir.
