Generic Auth (Rest), genellikle bir uygulamanın veya sistemin kullanıcıların kimlik doğrulama işlemlerini gerçekleştirmek için kullandığı bir kimlik doğrulama sağlayıcısıdır. Bu durumda Generic Auth (Rest) olarak adlandırılan sağlayıcı, REST API tabanlı kimlik doğrulama işlemlerini yönetmek için kullanılmaktadır. Generic olarak REST API’nin token’nını çağırabilen bir yapı oluşturmaktadır.
Kuika ile geliştirdiğiniz uygulamanın Backend yapılandırmasını yaparken Generic Auth(REST)‘ u backend yapılandırması içerisine ekleyebilirsiniz.
1. Kimlik Doğrulama Sağlayıcısı Olarak Generic Auth (REST) Ekleme
Header alanında yer alan Configuration Manager modülüne tıklayın. Configuration Manager’i isimlendirerek yeni bir yapılandırma ayarı oluşturun.
App Settings içerisinden Authentication &Authorization alanı içerisinden Authenication Provider alanına gelin.
Authentication Provider yapılandırması ekleme
Selectbox içerisinden ADD NEW’e tıklayın. Type alanından Generic Auth’u seçin. Kuika ile geliştirdiğin uygulamalara kimlik doğrulama sağlayıcısı olarak Generic Auth(Rest)'i ekleyebilirsiniz
Generic Auth (REST) ekranında ayarları yapmak için istenen bilgileri doldurmalısınız.
Name başlığı karşısında yer alan metin giriş kutusu aracılığıyla kimlik doğrulama sağlayıcısına isim verin.
Generic Auth(Rest) için yapmanız gereken bir sonraki işlem Token ayarlarını yapmaktır. Token Settings açılır menüsü içerisinde doldurman gereken bazı bilgiler mevcuttur.
Öncelikle kullanıcı bilgilerine erişim sağlamak için REST API URL girişini sağlamalısınız.
URL, Token’ı almak için kullanıcının dışarı açtığı, Token’ı dönen API URL’idir. URL’i Swagger içerisinden alabilmeniz mümkündür.
Token dönen API’nin Content Type’i ne ise o seçilir.
application/json, bir veri iletimi ve depolama biçimidir ve metin tabanlı veri formatları için kullanılan bir medya türü (media type) veya MIME türüdür. JSON, verileri anahtar-değer çiftleri şeklinde düzenler. Bir JSON verisi, nesneler (objects), diziler (arrays), sayılar, metinler, boole (true/false) değerler ve null (boş) değerler gibi temel veri tiplerini içerebilir.
application/x-www-form-urlencoded, web tarayıcıları tarafından sunuculara gönderilen veri formunun (form data) kodlanmış bir medya türüdür (MIME type).
Bu tür kodlama, verileri URL uyumlu hale getirir, böylece özel karakterler ve boşluklar gibi URL'de özel anlam taşıyan karakterler uygun şekilde kodlanır. Örneğin, bir kullanıcı adı "john_doe" ve şifre "pass123" olarak girildiğinde, bu form verileri şu şekilde gönderilebilir: username=john_doe&password=pass123
Token’ın Zaman aşımı süresini dakika tipinde Expiration In Minutes alanında belirlenmektedir. “Expiration In Minutes” başlığı karşısında yer alan metin kutusu aracılığıyla Token geçerlilik süresini sayısal değer olarak girin. Örneğin (30min girildiğinde bu değer girilir. Convert edilmez.
Daha sonra girilen URL’ de yer alan bilgilerin çağrılması için ekstra bir Header, Query ve Body parametresi varsa parametre ekle ve parametre bilgilerini key ve value pair olarak girin.
Header seçildiğinde, Rest API çağrılırken Header parametresi olarak kullanılmaktadır. Bir Header parametresi olarak "Authorization" başlığı kullanarak kimlik doğrulama bilgilerini gönderebilirsiniz. Bu başlık, kimlik doğrulama sağlayıcısına kullanıcı kimliğinizi doğrulamak için gerekli bilgileri iletmek için kullanılır.
Query seçildiğinde, query parametresi, genellikle kullanıcıyı kimlik doğrulama sayfasına yönlendirmek veya kimlik doğrulama işlemi sırasında belirli bilgileri iletmek için kullanılır. Örneğin,
Body seçildiğinde, Body parametresi, belirli bir medya türünü (MIME türünü) belirtir. Bu, Body’in nasıl işleneceğini ve yorumlanacağını belirler. Örneğin, bir JSON verisi içeren bir HTTP gövdesi için application/json MIME türü kullanılırken, bir HTML sayfası için text/html MIME türü kullanılabilir.
Body genellikle POST ve PUT İsteklerinde kullanılmaktadır. Verilerin sunucuya gönderilmesi gerektiği durumlarda, Body parametresi kullanılır. Özellikle web formları gibi veri girişi veya güncelleme işlemlerinde sıkça kullanılır.
Kuika, kullanıcı adı ve şifre parametrelerini otomatik olarak eklemeye olanak sağlamaktadır. Tek yapmanız gereken parametre başlığı altında yer alan ADDPARAMETERS butonuna tıklayarak, açılır menüde yer alan Custom ,Username, Password, öğelerini seçmektir.
Username ve Password öğelerinin Value bilgileri otomatik olarak Kuika tarafından doldurulmaktadır. Sadece parametre türünü (Header, Query, Body) ve key’lerini belirtmen yeterli olacaktır.
Generic Auth (Rest) için eklemeniz gereken bir diğer bilgi Refresh Token ayarlarıdır. Refresh Token, zaman aşımı gerçekleşmesinden dolayı erişimi sağlamak için yenileme işlemi yapılmasına olanak sağlamaktadır.
Refresh Token’i, Refresh Token Settings sekmesi aracılığıyla ayarlayabilirsiniz.
Öncelikle Token URL başlığı karşısında yer alan metin kutusu aracılığıyla Refresh Token Url’i girin.
Ardından URL Content Type başlığı karşısında yer alan açılır menü aracılığıyla URL içerik türünü seçin.
Daha sonra girilen Refresh Token URL’ de yer alan bilgilerin çağrılması için ekstra bir Header, Query ve Body parametresi varsa parametre ekle ve parametre bilgilerini key ve value pair olarak girin.
Kuika, Token ve Refresh Token parametrelerini otomatik olarak eklemeye olanak sağlamaktadır. Tek yapman gereken parametre başlığı altında yer alan “ADD” butonuna tıklayarak, açılır menüde yer alan Token ve Refresh Token öğelerini seçmektir.
Token ve Refresh Token öğelerinin Value bilgileri otomatik olarak Kuika tarafından doldurulmaktadır. Sadece parametre türünü (Header, Query, Body) ve key’lerini belirtmeniz yeterli olacaktır.
Generic Auth (Rest) için eklemeniz gereken bir diğer bilgi “Response” bilgisidir.
Girilen Token bilgilerinin yürütülmesiyle bir Response dönüşü sağlanacaktır.
Dönen Response’ un Kuika’ da eşleştirilmesi için bazı bilgilere ihtiyaç duyulmaktadır.
Generic Auth(REST) Response ayarlarının girilmesi
Bu bilgiler Access Token, User Name, First Name, Last Name ve Refresh Token bilgileridir. Bu bilgilere geri dönen .json dosyası içerisinden erişebilirsiniz.
Eğer Refresh Token’a sahipseniz Response altında yer alan Refresh Token başlığı karşısında yer alan metin kutusu aracılığıyla Refresh Token bilgisini girebilirsiniz.
Gerekli olan bilgilerin girişini sağladıktan sonra CREATE butonuna tıklayarak kimlik doğrulama sağlayıcını oluştur.
