Kuika’nın API Builder modülü, geliştirdiğiniz uygulamayı diğer uygulamalar ve hizmetler için veri kaynağı haline getirme imkanı sunar. API, “Application Programming Interface”in kısaltması olup, bir yazılım uygulamasının başka bir uygulama veya hizmetle iletişim kurmasını sağlayan bir arayüzdür. API’ler, farklı sistemlerin ve uygulamaların veri alışverişini standart bir yapıda gerçekleştirmesini sağlar, böylece uygulamalar arasında kolayca etkileşim kurulabilir. API Builder modülü, uygulamanızın diğer platformlar tarafından veri kaynağı olarak kullanılabilmesini sağlayarak, uygulamanın veri alıp gönderme işlemlerini kolaylaştırır. Örneğin, Kuika üzerinde geliştirilmiş bir yemek siparişi uygulamasının, bir restoranın menüsünü almasını sağlayabilirsiniz. Bu işlem için API, uygulamanızın restoran menüsüne erişimini sağlayacak bir endpoint (URL) sunar. Uygulamanız bu URL'ye istek gönderir ve restoranın menüsünü alarak kullanıcıya gösterebilir. Aynı şekilde, bir sipariş verildiğinde, uygulamanız bu siparişi API aracılığıyla restorana iletebilir ve sipariş durumu ile ilgili geri bildirim alabilir.Bu eğitim içeriğinde, Kuika’nın API Builder modülünü kullanarak API tanımlarını nasıl yapılandırabileceğinizi öğreneceksiniz.
API Builder modülü, web ve mobil uygulamalarda desteklenmektedir.
Bu eğitim içeriği aşağıdaki başlıklardan oluşmaktadır:
API Builder oluşturma,
API Builder paneli,
API Method oluşturma ve Properties paneli.
API Builder Oluşturun
Kuika platformuna giriş yaptıktan sonra “Apps” ekranından çalışacağınız projeyi açın.
Ardından “API Builder” modülüne tıklayın.
Açılan ekrandan bir isim (1) verin ve “CREATE” (2) butonuna tıklayın.
API Builder Paneli
API Builder Paneli, Kuika üzerinde oluşturulan tüm API Builder tanımlarının bir arada yönetildiği bir kontrol panelidir. Bu panel sayesinde API yönetimini hızlı ve kolay bir şekilde gerçekleştirebilirsiniz. Sol kenardaki API Builder Paneli’nin sunduğu temel işlevler şunlardır:
Yeni API Oluşturma: Panel aracılığıyla, uygulamanızın ihtiyaç duyduğu yeni bir API tanımı oluşturabilirsiniz. Bu işlem sırasında, API’nin temel yapılandırmasını yaparak veri alışverişi için gereken yapı taşlarını belirleyebilirsiniz. Örneğin, bir yemek siparişi uygulaması geliştiriyorsanız, bu panel üzerinden restoran menüsü, sipariş bilgileri gibi verileri yönetebilecek API'ler oluşturabilirsiniz.
Mevcut API’leri Güncelleme: Panel, oluşturulmuş API’lerin isimlendirme, açıklama ve genel özelliklerinde düzenleme yapmanıza olanak tanır. API isimlerinde veya açıklamalarında değişiklik yapmak, uygulamanızın genel yapısını bozmadan düzenli bir yapı sağlar. Bu sayede, uygulamanızın API’lerini daha iyi organize edebilir ve farklı veri kaynakları ile olan ilişkileri yönetebilirsiniz.
API Silme İşlemi: Geliştirme sürecinde artık gerekmeyen veya kullanılmayan API’leri, API Builder Paneli üzerinden Delete ikonu yardımıyla silebilirsiniz. Özellikle, eski sürümlerde kullanılan veya farklı bir fonksiyon ile değiştirilen API’lerin kaldırılması, uygulamanın performansı ve güvenliği için önemlidir.
API Durum Kontrolü ve Önizleme: Panel aracılığıyla API'lerin çalışma durumlarını gözden geçirebilir ve ihtiyaç halinde canlı ortamda test edebilirsiniz. Böylece API’lerin doğru çalışıp çalışmadığını kontrol etmenize ve olası sorunları önceden tespit etmenize olanak tanır. Ayrıca, önizleme sayesinde API’nin veri döndürme biçimini ve çıktısını önceden inceleyebilir ve gerektiğinde düzeltmeler yapabilirsiniz.
Güvenlik ve Yetkilendirme Ayarları: API'ler üzerinde gerekli güvenlik önlemlerini almak ve yetkilendirme işlemlerini yapılandırmak için paneli kullanabilirsiniz. API'lerin sadece yetkili kullanıcılar veya uygulamalar tarafından kullanılmasını sağlayarak, veri güvenliğini koruyabilirsiniz.
API Builder Method Oluşturma ve Properties Paneli
API Builder oluşturulduktan sonra, ekranda sağ üst köşede bulunan ADD NEW METHOD butonuna tıklayarak yeni bir method tanımlamaya başlayabilirsiniz. Bu adımdan sonra, method için bir isim belirleyebilir ve methodun özelliklerini yapılandırabilirsiniz. Method oluşturma işlemi sırasında ekranın sağında yer alan Properties panelini kullanarak yetkilendirme ve aksiyon ekleme işlemlerini yapabilirsiniz. Oluşturduğunuz methodları istediğiniz zaman silebilir veya yeniden adlandırabilirsiniz.
Properties Panelinde Bulunan Alanlar:
Authorization (Yetkilendirme): API’nin kullanımını yetkilendirme seçenekleri ile belirleyebilirsiniz. Eğer herhangi bir doğrulama istemeden API'nin herkes tarafından kullanılmasını istiyorsanız, Anonymous Access seçeneğini seçebilirsiniz. Ayrıca, tüm rollere açık hale getirmek için All Roles Access seçeneğini de kullanabilirsiniz.
Add Actions (Aksiyon Ekleme): Method çağrıldığında çalışmasını istediğiniz platform aksiyonlarını eklemenizi sağlar. Methodun API üzerinden bir işlem gerçekleştirmesi gerekiyorsa burada aksiyon tanımlayabilirsiniz.
Method Input: Eğer methodunuz belirli bir input değeri alarak çalışacaksa, bu alan üzerinden input özelliklerini tanımlayabilirsiniz. Bu özellikler arasında input adı, tipi gibi detaylar yer alır.
Örnek Senaryo: API Method Yapısının Kullanımı
Örneğin, menü içeriği sunan bir uygulama geliştirdiğinizi varsayalım. Bu uygulamada, bir Barcode numarasını input olarak alıp, durum kodunu (status code) respons olarak döndürmek isteyebilirsiniz.
İlk olarak, UI Design modülünde Custom Actions panelini veya Datasources modülünü kullanarak yeni bir Custom Action oluşturun. Bu Custom Action, bir input alarak sonuç olarak bir durum kodu döndürecektir.
SQL Editör alanına girerek gerekli sorguları yazabilirsiniz. SQL editör, elle yazacağınız sorguları veya yapay zeka yardımı ile oluşturulan sorguları kabul eder. Örneğin, aşağıdaki sorguyu ekleyebilirsiniz:
SELECT Barcode, Status FROM Menu WHERE Barcode =@Barcode
Aksiyonunuza bir isim (örneğin, Status Inquiry) verin ve CREATE butonuna tıklayın. Bu aksiyonu API Method içine çağırmak için +ADD ACTION butonuna tıklayın ve açılan arama çubuğuna Status Inquiry yazarak aksiyonu ekleyin.
Oluşturulan aksiyonun parametresini Symbol Picker aracılığıyla Action Results → Status Inquiry olarak tanımlayın.
SQL Editör içinde “@” ile belirttiğiniz Barcode parametresi, dışarıdan bir method input olarak API’ye açılmalıdır. Bunun için +ADD METHOD INPUT butonuna tıklayın, Input Name alanına Barcode yazın, input tipini Guid olarak belirleyin ve Create butonuna tıklayın.
Oluşturduğunuz aksiyon, dışarıdan parametre alıp SQL sorgularını yürütmeye hazır hale gelir. Tüm yapılandırmaları test etmek için Preview butonuna tıklayın. Önizleme sonucunda URL kısmında Swagger yazısına tıklayarak API’niz ve eklenen method işlemlerini görüntüleyebilirsiniz. Bu işlemlerin yalnızca oturum açmış kullanıcılar tarafından mı, yoksa herkes tarafından mı görüntülenebileceğini Properties panelindeki Authorization alanından ayarlayabilirsiniz.
