1. Kuika platformuna girin ve Apps ekranından projenizi açın.

2. API Builder modülünü açın.
3. Yeni bir API için isim belirleyin.‍
4. CREATE butonuna tıklayarak API'nizi oluşturun.

API Builder Paneli, Kuika üzerinde oluşturulan tüm API tanımlarını yönetmenizi sağlar. Bu panelde 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 içinde ADD NEW METHOD butonuna tıklayarak yeni bir method oluşturun.
• Method adı belirleyin ve sağ tarafta bulunan Properties paneli üzerinden method ayarlarını yapılandırın.

Properties Paneli Alanları

Authorization

Method’a özel yetkilendirme ayarlarını bu alandan yapılandırabilirsiniz. API methodu için erişim seviyesi belirlenebilir.

• Anonymous Access: API herkes tarafından erişilebilir olur.
• All Roles Access: Tüm yetkilendirilmiş kullanıcılar erişebilir.
• Rol bazlı erişim kısıtlaması tanımlanabilir.

Request Ayarları

HTTP Method

Method’un hangi HTTP tipi ile çalışacağını belirler.

Desteklenen method türleri:

• POST
• GET
• PUT
• DELETE
• PATCH

Seçilen HTTP Method, API’nin veri alma veya veri değiştirme davranışını belirler.

Content Type (Request)

API’ye gönderilecek verinin formatını belirler.

Desteklenen içerik türleri:

• application/json
• application/x-www-form-urlencoded
• application/xml

Örneğin:

• JSON payload gönderilecekse application/json
• Form-data gönderilecekse application/x-www-form-urlencoded seçilmelidir.

Response Ayarları

Content Type (Response)

API’nin döndüreceği yanıt formatını belirler.

Desteklenen yanıt türleri:

• application/json
• text/html

Genellikle veri tabanlı API’lerde application/json tercih edilir.

Actions

+ ADD ACTION butonu ile method çağrıldığında çalışacak aksiyonlar eklenir.

Eklenen aksiyonlar:

• Custom Action
• SQL Action
• REST Action
• System Action

Aksiyon sonuçları Symbol Picker üzerinden Response’a bağlanabilir.

Method Inputs

API’nin dışarıdan parametre almasını sağlar.

Input Type

• Manual: Parametreler tek tek tanımlanır.
• Dynamic: JSON obje yapısı üzerinden parametre alınır.

Manual Input

+ ADD METHOD INPUT butonuna tıklayarak yeni parametre eklenir.

Alanlar:

• Input Name
• Type
• Description

Payload tipi seçilebilir:

• Object
• List of Objects

Array (çok satırlı) veri yapısı sayesinde, API methodu tek bir istekte birden fazla kaydı işleyebilir. Bu yapı özellikle:

• Toplu kayıt ekleme
• Toplu güncelleme
• Çoklu ürün / çoklu satır veri gönderimi
• Batch işlem senaryoları için kullanılır.

Dynamic Input

Dynamic seçildiğinde JSON Object alanı açılır. Örnek yapı:

{
  "paramName": "Value1",
  "paramName2": 10,
  "paramName3": 10.4,
}

Bu yapı, methodun beklediği request gövdesini tanımlar.  Burada bulunan değerler ile sistem ilgili parametrenin tipini otomatik anlar. Aşağıda kritik olan ve sistemin varsayılan olarak tip tanımlama kriterleri belirtilmiştir:

Numeric: Eğer değer Float değil ise sistem otomatik olarak tipi Long seçer. Eğer değer Float ise yani “.” içeriyor ise sistem ilgili parametre tipini decimal olarak belirler.

DateTime: Sistem sadece DateTime olarak “iso” formatını tanır.  “YYYY-MM-DDThh:mm:ss” kalan DateTime değerleri otomatik string tipi olarak belirlenir.

Örnek Senaryo 

Barkod numarasına göre menü durumu döndüren bir API oluşturulacak.

1. API Builder modülüne girin.
2. ADD NEW METHOD ile yeni method oluşturun.
3. HTTP Method olarak POST seçin.
4. Request Content Type olarak application/json seçin.
5. Response Content Type olarak application/json seçin.
6. Authorization ayarını belirleyin.
7. + ADD ACTION ile Status Inquiry aksiyonunu ekleyin.
8. Symbol Picker ile Action Results → Status Inquiry seçin.
9. Method Input olarak:
   
   • Input Name: Barcode
   • Type: Guid
   • Payload: Object
10. Preview butonu ile API’yi test edin.
11. Swagger ekranından method çıktısını kontrol edin.