Kullanıcı Kılavuzu

OData ile Veri Kaynağı Ekleme Kullanıcı Kılavuzu

24/9/26
OData ile Veri Kaynağı Ekleme Kullanıcı Kılavuzu

OData API

OData API, Kuika platformunda kullanabileceğiniz harici veri kaynaklarından biridir. Mevcut bir OData servisini Kuika'da geliştirdiğiniz uygulamaya veri kaynağı olarak entegre edebilirsiniz. Bu eğitim içeriğinde, OData API kullanarak uygulamanıza nasıl veri kaynağı ekleyebileceğinizi öğreneceksiniz.

‍

OData API ile Uygulamanıza Veri Kaynağı Bağlantısı Ekleyin

  1. Kuika platformuna giriş yapın ve Apps ekranından çalışacağınız projeyi açın.
  2. Üst menüden Datasources modülünü açın. Bu modülde uygulamanızdaki veri kaynaklarını ve aksiyonları Recently modified ve Data sources sekmeleri altında görüntüleyebilir, Search by name alanı ile arama yapabilir ve yeni bir veri kaynağı ekleyebilirsiniz.
  3. Ekranın üst kısmındaki kartlardan Create an API kartına tıklayın. Bu kart Swagger, REST, OData, SAP ve MQTT broker bağlantıları oluşturmanızı sağlar.
  4. Açılan listede APIs & Services başlığı altındaki OData (Open Data Protocol) seçeneğini belirleyin. Listede gezinmek için ↑/↓ tuşlarını, seçim yapmak için Enter tuşunu da kullanabilirsiniz.
  1. Name alanına veri kaynağınız için bir isim girin (örn. userguideodata).
  2. CREATE butonuna tıklayarak işlemi tamamlayın. İşlemden vazgeçmek için CANCEL butonunu, bağlantı tipi seçimine geri dönmek için < OData bağlantısını kullanabilirsiniz.

Not: Sol paneldeki Sources başlığının yanında yer alan + ikonu ile de yeni veri kaynağı ekleme işlemini başlatabilirsiniz.

OData API Modalının Anatomisi

A. Üst Menü

  • Geri Butonu (←): Datasources ekranına geri dönmenizi sağlar.
  • Veri Kaynağı Adı: Oluşturduğunuz OData veri kaynağının adı (örn. userguideodata) görüntülenir. Yanındaki açılır ok ile veri kaynakları arasında geçiş yapabilir, kalem ikonu ile adı düzenleyebilirsiniz.
  • CREATE Butonu: Bağlantı ayarlarını kaydeder ve ekranı kapatır.

B. 01 Endpoint

Kuika'nın bağlanacağı servis bilgilerini içerir.

Alanların yanındaki (i) ikonlarının üzerine gelerek alanlarla ilgili açıklamaları görüntüleyebilirsiniz.

C. 02 Authentication

Kuika'nın servise kendini nasıl tanıtacağını belirler.

  • Authentication type: API erişimi için kimlik doğrulama türünü seçtiğiniz alandır. No Auth, Bearer, Basic ve API Key seçenekleri bulunur.
  • Header Tablosu: Type, Key ve Value sütunlarından oluşur. Seçilen kimlik doğrulama türüne göre gerekli satırlar tabloya otomatik eklenir. Custom tipindeki satırlar ile isteğe bağlı ek alanlar tanımlayabilirsiniz.

D. Sağ Panel

  • Description: Veri kaynağı hakkında not ekleyebileceğiniz alandır.
  • Learn More: OData user guide bağlantısı ile ilgili dokümantasyona ulaşabilirsiniz.
  • After You Create: CREATE butonunun bağlantıyı kaydedip bu ekranı kapattığını belirtir.

OData API Bağlantı Ayarlarını Yapılandırma

  1. Endpoint bölümünde Metadata URL ve Service base URL bilgilerini girin.
  2. Authentication bölümünde Authentication type alanından kimlik doğrulama türünü seçin ve ilgili alanları doldurun.
  3. Gerekirse header tablosuna Custom satırlar ekleyin.
  4. İsterseniz Description alanına veri kaynağıyla ilgili bir not yazın.
  5. Sağ üstteki CREATE butonuna tıklayarak ayarları kaydedin.

OData API Authentication Türleri

1. No Auth

Kimlik doğrulama gerektirmeyen servisler için kullanılır. Ek bir ayar yapmanız gerekmez; isterseniz header tablosundaki Custom satır ile ek alanlar tanımlayabilirsiniz (bkz. odata4.png).

2. Bearer

Token tabanlı doğrulama yöntemidir. Token, istek başlığında aşağıdaki şekilde gönderilir:

Authorization: Bearer YOUR_ACCESS_TOKEN

Bearer seçildiğinde header tablosuna Username tipinde bir satır otomatik eklenir. Bu satırın değeri {CurrentUserName} olarak sabittir ve uygulamada oturum açmış kullanıcının adını ifade eder; Key alanına bu değerin gönderileceği başlık adını girebilirsiniz.

Eğer token kullanıcı adı ve parola ile alınıyorsa, önce bir "login" işlemi yapılmalı, ardından alınan token ile işlem devam ettirilmelidir.

3. Basic

Kullanıcı adı ve parola ile doğrulama yapılır.

  • Username: Basic auth kullanıcı adı.
  • Password: Basic auth parolası. Göz ikonu ile parolayı gösterebilir veya gizleyebilirsiniz.

Basic seçildiğinde header tablosuna Basic Auth. tipinde, Authorization anahtarlı ve {BasicAuthToken} değerli bir satır otomatik eklenir. Bu satır kilitlidir ve girdiğiniz bilgilerden oluşturulan token'ı şu şekilde gönderir:

Authorization: Basic base64(username:password)

İsterseniz Custom satırlar ile özel parametreler ekleyebilirsiniz.

4. API Key

API'ye erişim için API anahtarı (key) ve gerekiyorsa gizli anahtar (secret) kullanılır. Bu bilgiler genellikle API sağlayıcısı tarafından verilir.

  • ID key name: API kimlik anahtarının adı (örn. client_id, api_key, x-api-key).
  • ID: Size özel API kimlik değeri.
  • Secret key name: Gizli anahtarın başlık adı (örn. client_secret, secret_key).
  • Secret: Size özel gizli anahtar değeri. Göz ikonu ile değeri gösterebilir veya gizleyebilirsiniz.

İsterseniz header tablosundaki Custom satırlar ile ek alanlar tanımlayabilirsiniz.

Bu değerler API sağlayıcısına göre header veya query parametresi olarak gönderilir:

  • Header ile:
    • client_id: YOUR_ID
    • client_secret: YOUR_SECRET
  • Query parametresi ile: https://api.example.com/data?client_id=YOUR_ID&client_secret=YOUR_SECRET

API sağlayıcısının dokümantasyonuna göre bu değerler farklı isimlerde olabilir. Kuika'da bu değerleri doğru başlık adlarıyla tanımlayarak entegrasyonu gerçekleştirebilirsiniz.

Bu adımları takip ederek OData API veri kaynağını Kuika uygulamalarınıza kolayca entegre edebilirsiniz.

Sözlük

No items found.

Alt Başlıklar