API oluşturun (API Builder)

API Builder modülünü keşfedin

API, Application Programming Interface'nin kısaltmasıdır. 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 birlikte çalışmasını ve veri alışverişini kolaylaştırır.

API'ler, çeşitli platformlar arasında veri iletimini sağlar. Bir uygulama, başka bir uygulamadan veya hizmetten veri almak veya veri göndermek için API'leri kullanır. API'ler, bu veri alışverişini standartlaştırır ve uygulamalar arasındaki etkileşimi kolaylaştırır.

Kuika, API hizmetini uygulama içerisinde bulunan API Builder modülü ile kullanıcılara sunmaktadır. Kuika ile geliştirdiğin uygulamayı farklı uygulamalar için veri kaynağı olarak kullanabilme olanağını API Builder modülü ile sunmaktadır.

Örneğin, Kuika üzerinde geliştirilmiş yemek siparişi uygulamanızın bir restoranın menüsünü almasını düşünün. API, uygulamanızın restoranın menüsünü alabilmesi için belirli bir endpoint (URL) sağlar. Uygulamanız bu URL'ye istek gönderir ve API, restoranın menüsünü döndürerek size geri döner. Bu sayede, uygulamanız restoranın menüsünü alabilir ve kullanıcılara gösterebilirsiniz.

Aynı şekilde, kullanıcı bir sipariş verdiğinde, uygulamanız bu siparişi API aracılığıyla restorana iletebilir. API, siparişin restorana iletildiğini doğrular ve restorandan gelen cevabı size ileterek kullanıcıya geri bildirimde bulunmasını sağlar.

API Builder modülü aracılığıyla Kuika’da geliştirdiğiniz uygulamaları API olarak veri kaynağına çevirebilirsiniz.

API Builder mobil ve web uygulamaları desteklemektedir.

API Builder Oluşturun.
API Builder Paneli
API Builder Method Oluşturma ve Properties Paneli

API Builder oluşturulduktan sonra açılan ekranda sağ üst köşede yer alan ADD NEW METHOD Butonuna tıklayıp isimlendirme yaparak API Builder Method oluşturmaya başlayın. Method oluştururken sağ tarafta Properties paneli yer almaktadır. Properties panelini kullanarak yetkilendirme ve aksiyon ekleme işlemlerini gerçekleştirebilirsiniz. İstediğiniz zaman oluşturduğunuz methodları silebilir veya yeniden adlandırabilirsiniz.

Properties panelinde Authorization, Actions, Method Inputs alanları yer almaktadır.

Authorization

API hizmetini yetkilendirme vererek açılması All Roles Access ile herhangi doğrulama istemeden kullanım için Anonymous Access seçeneği kullanılmaktadır.

Add Actions

Method çağrıldığında platform tarafında çalışması istenilen aksiyonların eklendiği alandır.

Method Input

Kullanılacak aksiyonlar input değerleri barındırıyorsa bu değerlerin tipi, ismi vs özelliklerin girildiği alandır.

Örnek bir senaryo üzerinde API method yapısı ele alınabilir. Örneğin, içerisinde menü olan bir uygulama olduğu varsayılsın. Bu uygulama içerisinde Barcode numarası input olarak verilsin. Durum kodu responsive olarak geri döndürürsün.

İlk olarak uygulama içerisinde yer alan UI Design modülünde Custom Actions paneli üzerinden veya Datasources modülüne veri kaynağına eklediğiniz Actions başlığı altından yeni bir Custom Actions oluşturun. Bu Custom actions ile bir input alıp sonuç olarak responsive bir değer döndürecektir.

Açılan SQL Editör içerisinde istenilen sorguları manual olarak yazabilir veya yapay zeka yardımı ile kolaylıkla sorgu ekleyebilirsiniz.

SQL editör içerisine

Copyselect Barcode Statu from Menu Where Barcode = @Barcode

gibi sorgular eklendikten sonra status inquiry gibi isimlendirip CREATE butonuna tıklayın. Oluşturulan aksiyonu API Method içerisine çağırmak için +ADD ACTION’a tıklayın. Arama çubuğuna status inquiry (oluşturduğunuz aksiyon) yazarak aksiyonu ekleyin.Oluşturulan aksiyon parametresi Symbol Picker aracılığıyla Action Results → status inquiry (oluşturduğunuz aksiyon) şeklinde doldurulmalıdır.

SQL Editör içerisinde @ işareti ile tanımlanan Barcode parametresi dışarı açılan API olduğundan dolayı bir Method Input’un oluşturulması gerekmektedir. Method Input’un oluşturulması için + ADD METHOD INPUT’a tıklayın. Input Name alanına @ ile yazılan parametre yani Barcode yazın. Input tipini Guid seçip Create butonuna tıklayın.

Oluşturulan aksiyon dışarıdan parametre alıp yazılan SQL sorgularını almaya hazır durumdadır. Yapılan işlemleri test edebilmek için Preview butonuna tıklayın. Sonuç olarak preview sonucunda URL kısmına Swagger yazarak son yapılan API ve eklenen method işlemlerini görüntüleyebilirsiniz. İşlemleri Sign in yapıp görüntülenmesini veya herkesin görüntüleyebilmesini Properties panelinden Authorization alanından ayarlayabilirsiniz.