API'ler
API'ler sayfası, API Üreticisi (API Producer) tarafından yayında olan API Ürünleri (API Products) yer alır.
Üç farklı API tipi bulunur; Public, Authentication Needed ve Authentication and Permission Needed. API Tüketicisi, portal uygulamasına giriş yapmadığında sadece Public API'ler görüntülenir.
Buradaki listede her API'nin, ad, avatar, açıklama, bu ürüne abone olunup/olunmadığı bilgisi, kimlik doğrulama gerekip/gerekmediği ve erişimin aktif olup/olmadığına ait durum bilgisi görülür.
API'ler ekranına ait görsele aşağıda yer verilmiştir:
Genel Bakış Sekmesi (Overview)
API üreticisi tarafından oluşturulan bilgiler görüntülenir.
Bir API'nin Genel Bakış sekmesini içeren görsele aşağıda yer verilmiştir:
Dokümantasyon & Test Sekmesi (Documentation & Test)
API'nin API tanım dosyasına (API Specification) Apinizer üzerinden erişilip, istenen uç nokta (endpoint) test edilebilir.
Bir API'nin Dokümantasyon & Test sekmesini içeren görsele aşağıda yer verilmiştir:
Uç nokta (endpoint) bilgileri olarak özet, açıklama, parametreler, istek gövdesi (body) ve yanıt gövdesi (response body) görüntülenmektedir.
Mevcut bilgileri güncellemek veya yeni bir kayıt eklemek isterseniz, Tasarım sekmesi (design) sayfasından nasıl yapabileceğinizi inceleyebilirsiniz.
Şema (schema) alanı, ilgili endpoint'in şema bilgisi tanımlarını görüntülemek için kullanılır ve verinin nasıl gönderileceğini belirtir.
Örnek (Example) alanı, gönderilecek body'nin örnek içeriğini gösterir:
API Portal Endpoint Test için:
API Product'a kayıt olup bir API Key seçildiği zaman, Authorization bilgisi otomatik olarak gelecektir. Bu, kullanıcıların API erişim anahtarlarını (API Key) manuel olarak girmelerine gerek kalmadan yetkilendirme bilgilerini alarak API çağrılarını test etmelerini sağlar.
Bir API'nin Endpoint Test'ini içeren ve Authorization bilgisinin otomatik olarak geldiği görsele aşağıda yer verilmiştir:
Uygulamalarım Sekmesi (Application)
Portalda giriş yapan kullanıcı, Uygulamalarım Sekmesi üzerinden mevcut uygulamalarını görüntüleyebilir veya yeni bir uygulama oluşturabilir. Eğer kullanıcının henüz bir uygulaması yoksa, bu alandan yeni bir uygulama oluşturulmasına izin verilir. Bu süreçte kullanıcı, yeni bir uygulama adı ve gerekli bilgileri girerek uygulama kaydını tamamlar. Sonrasında, kullanıcı bu yeni oluşturulan uygulamayı API Register (API kaydına alma) işlemi için kullanabilir.
Hiç uygulaması olmayan bir kullanıcının uygulama oluşturması detayı için Uygulamaları Oluşturun, Düzenleyin ve Silin sayfasını ziyaret edebilirsiniz.
Eğer kullanıcı zaten bir uygulama oluşturmuşsa, Uygulamalarım Sekmesi altında mevcut uygulamaları görüntüleyebilir ve bunlara ait işlemleri gerçekleştirebilir. Bu durumda, Register Ol butonu aktif olur ve kullanıcı mevcut uygulamasını API'lere kaydettirip erişim alabilir. Yani, bir kullanıcı yalnızca uygulama oluşturduktan sonra API'leri kullanabilmek için kayıt olma adımını tamamlayabilir.
Bir API'nin Uygulamalarım sekmesini içeren görsele aşağıda yer verilmiştir:
Uygulaması mevcut olan bir kullanıcı için, API'ye kaydolmak amacıyla Register Ol butonu aktiftir. Bu butona tıklayarak, kullanıcı mevcut uygulamasını seçip ilgili API'lere kaydolarak erişim sağlayabilir.
Bir API'nin Uygulamalarım sekmesinde Register olmasını içeren görsele aşağıda yer verilmiştir:
Pano Sekmesi (Dashboard)
Pano Sekmesinin aktif olması için API Developer Portal ayarları kısmından "Hesapların Analytcis bilgilerini görüntülemesine izin ver (Allow accounts to view their Analytics information)" seçeneğinin tabloda etkinleştirilmiş olması gerekir. Bu buton kapalı olması durumunda ekranda "Pano" ve "API Trafik" durumları görüntülenemeyecektir.
İlgili API'nin genel durumu izlenir.
Bir API'nin Pano sekmesini içeren görsele aşağıda yer verilmiştir:
API Trafik Sekmesi (API Traffic)
API'ye gelen tüm istek ve yanıtlar, detaylarıyla beraber listelenir. Özellikle, mesajdaki bir sorunu araştırmayı kolaylaştırır.
Bir API'nin API Trafik sekmesini içeren görsele aşağıda yer verilmiştir: