API Builder Modülünü Keşfedin

API Builder Modülünü Keşfedin

Kuika'nın API Builder modülü, geliştirdiğiniz uygulamayı diğer uygulamalar ve hizmetler için veri kaynağı haline getirmenizi sağlar. API (Application Programming Interface), farklı sistemler ve uygulamalar arasında veri alışverişini standart bir yapıda gerçekleştiren bir arayüzdür.

Bu modül sayesinde, uygulamanızın veri alıp gönderme işlemleri kolaylaşır. Örneğin, Kuika'da geliştirilmiş bir yemek siparişi uygulaması, bir restoranın menüsünü API aracılığıyla alabilir. Benzer şekilde, sipariş verildiğinde bu bilgiyi API üzerinden restorana iletip geri bildirim alabilirsiniz. Bu eğitim içeriğinde, Kuika API Builder modülünü kullanarak API tanımlarının nasıl yapılandırılacağını öğreneceksiniz.

Bu eğitim içeriği aşağıdaki başlıklardan oluşur: 

  • API Builder oluşturma
  • API Builder paneli
  • API Method oluşturma ve Properties paneli kullanımı
API Builder Oluşturun
  1. Kuika platformuna girin ve Apps ekranından projenizi açın.
  1. API Builder modülünü açın.
  2. Yeni bir API için isim belirleyin.
  3. CREATE butonuna tıklayarak API'nizi oluşturun.
API Builder Modülü

API Builder modülü, Kuika üzerinde oluşturulan tüm API tanımlarını yönetmenizi sağlar. Bu modülde yapabilecekleriniz:

  • Yeni API oluşturma: Uygulamanızın ihtiyacına göre yeni API'ler tanımlayabilirsiniz.
  • Mevcut API’leri düzenleme: API adlarını, açıklamaları ve temel ayarları değiştirebilirsiniz.
  • API silme: Kullanılmayan API'leri Delete ikonuyla kaldırabilirsiniz.
  • API durum kontrolü ve önizleme: API'lerin çalışma durumunu test edebilir, veri dönüşlerini inceleyebilirsiniz.
  • Güvenlik ve yetkilendirme: API'lerin sadece yetkili kullanıcılar tarafından erişilebilir olmasını sağlayabilirsiniz.
API Builder Method Oluşturma ve Properties Paneli
  1. API Builder içinde ADD NEW METHOD butonuna tıklayarak yeni bir method oluşturun.
  2. Method adı belirleyin ve Properties panelinden ayarları yapılandırın.
  3. Method yetkilendirmesini seçin:
    • Anonymous Access: API herkes tarafından erişilebilir olur.
    • All Roles Access: Tüm yetkilendirilmiş kullanıcılar erişebilir.
  4. Add Actions seçeneği ile methodun çağırıldığında hangi işlemleri yapacağını belirleyin.
  5. Method Input tanımlayarak API’nin dışarıdan parametre almasını sağlayın.

Örnek Senaryo: API Method Yapısının Kullanımı

Senaryo: Bir uygulama, barkod numarası girişi yapıldığında menü durumu bilgisi döndürecek.

  1. UI Design modülünde veya Datasources modülünde yeni bir Custom Action oluşturun.
  2. SQL Editörüne aşağıdaki sorguyu ekleyin:
SELECT Barcode, Status FROM Menu WHERE Barcode = @Barcode
  1. Aksiyonunuza Status Inquiry adını verin ve CREATE butonuna tıklayın.
  2. +ADD ACTION butonu ile bu aksiyonu API Method’a ekleyin.
  3. Symbol Picker ile Action Results → Status Inquiry seçin.
  4. Method Input olarak Barcode tanımlayın:
    • Input Name: Barcode
    • Input Type: Guid
  5. Preview butonuna basarak API’yi test edin.
  6. Swagger sayfasından API ve method çıktılarını gözden geçirin.
  7. Authorization ayarından API’nin herkese mi yoksa oturum açmış kullanıcılara mı açık olacağını belirleyin.

Bu eğitim içeriği ile Kuika API Builder modülünde API oluşturma, method tanımlama ve API'leri yönetme konusunda temel bilgilere sahip oldunuz. API’nizi test ederek ve ayarlarını optimize ederek geliştirmenizi tamamlayabilirsiniz.

İlişkili diğer içerikler

No items found.

Sözlük

Alt Başlıklar