Rest Service

Bu aktivite, bir REST API isteği göndererek dış sistemlerle veri alışverişi yapılmasını sağlar. Öncelikle Rest servislerin çağrımı ve testleri ile ilgili geliştiriciler tarafından en çok kullanılan IDE'nin Postman olduğunu bilmekte fayda var. Postman'in nasıl kullanıldığına bakmak için ise burayı ziyaret edebilirsiniz.

Özellikler

• Display Name:Aktivitenin süreç içinde ayırt edilmesi için verilen isimdir. Varsayılan olarak "Rest Service" olarak ayarlanır.

• Description : Aktivitenin işlevini açıklayan isteğe bağlı bir not alanıdır. Sürecin bakımını kolaylaştırmak için kullanılır.

• Delay Before : Aktivite başlamadan önce geçen bekleme süresini (saniye cinsinden) belirtir.

  • Varsayılan Değer: 0 (Bekleme olmadan çalışır).

  • Örnek Kullanım: Aktivitenin çalıştırılmasından önce belirli bir süre beklemek gerekiyorsa, bu süre burada belirtilir. Örneğin, 2 yazılırsa aktivite başlamadan önce 2 saniye bekler.

• Delay After: Aktivite tamamlandıktan sonra geçen bekleme süresini (saniye cinsinden) belirtir.

  • Varsayılan Değer: 0 (Bekleme olmadan bir sonraki aktiviteye geçer).

  • Örnek Kullanım: İşlem tamamlandıktan sonra sistemde gecikmeler yaşanıyorsa ya da sonraki adımın başlaması için bir süre verilmesi gerekiyorsa, bu alanda belirtilir.

• Continue On Error: Aktivite sırasında bir hata oluştuğunda sürecin devam edip etmeyeceğini kontrol eden özelliktir.

  • True: Aktivite hata aldığında bile süreç çalışmaya devam eder.

  • False: Aktivite hata alırsa süreç durur.

  • Varsayılan Değer: False (Varsayılan olarak süreç hata alırsa durur).

  • Örnek Kullanım: Kritik olmayan işlemlerde hata olsa bile sürecin devam etmesi isteniyorsa bu seçenek True olarak ayarlanır. Örneğin, bir dosyanın varlığını kontrol eden bir aktivitede hata alınırsa ve süreç bu hataya rağmen devam etmeliyse bu seçenek aktif edilir.

Inputs

• HTTP Method

REST Service aktivitesinde gönderilecek isteğin türünü belirler. HTTP metodları, API’nin hangi işlemi gerçekleştireceğini ifade eder ve dropdown menü aracılığıyla seçilir.

Kullanılabilir Metodlar:

• GET

  • Amaç: Verileri sunucudan almak için kullanılır.

  • Body: Kullanılmaz.

  • Örnek Kullanım: https://api.example.com/users
  • Senaryo: Kullanıcı listesi veya belirli bir verinin sorgulanması.

• POST

  • Amaç: Sunucuya yeni veri göndermek veya yeni kayıt oluşturmak için kullanılır.

  • Body: Gereklidir (JSON/XML).

  • Örnek Kullanım:

    {

    "name": "gen",

    "role": "robot"

    }

  • Senaryo: Yeni kullanıcı kaydı oluşturma, form gönderimi.

• PUT

  • Amaç: Var olan bir veriyi güncellemek için kullanılır.

  • Body: Gereklidir.

  • Örnek Kullanım:

  {

  "id": 101,

  "email": "[e-mail]"

  }

  • Senaryo: Kullanıcının e-posta adresini güncelleme.

• DELETE

  • Amaç: Sunucudan belirli bir kaydı silmek için kullanılır.

  • Body: Genellikle kullanılmaz.

  • Örnek Kullanım: https://api.example.com/user/101
  • Senaryo: Belirli bir kullanıcıyı silme işlemi.

Params

• Veri Tipi: Text

• Açıklama: REST isteğine eklenecek URL parametreleridir. Genellikle ?key=value formatında kullanılır. Örneğin: https://api.example.com/data?id=123.
• Kullanım Örneği:

• userId=45 → Çağrılan API'de kullanıcıya özel bilgi isteniyorsa kullanılır.

Authorization

Kimlik doğrulama seçenekleri aşağıdaki gibidir:

• No Auth

  • Açıklama: Kimlik doğrulaması gerektirmeyen servislerde kullanılır.

  • Örnek Kullanım: Açık uçlu (public) API’lerde tercih edilir.

• Bearer Token

  • Veri Tipi: String

  • Açıklama: JSON Web Token (JWT) gibi kimlik belirteçleri ile yapılan kimlik doğrulamasıdır.

  • Örnek:

  • Header’da "Authorization": "Bearer eyJhbGciOi..." şeklinde kullanılır.

  • Genellikle kullanıcı oturumu açtıktan sonra sunucudan alınan token ile çalışır.

• Basic Auth

  • Veri Tipi: String (Kullanıcı adı ve şifre)

  • Açıklama: Kullanıcı adı ve şifre ile temel HTTP kimlik doğrulamasıdır.

  • Örnek:

  • Kullanıcı adı: admin, Şifre: 1234

  • Header’da "Authorization": "Basic YWRtaW46MTIzNA==" olarak şifrelenmiş şekilde iletilir.

Headers

Bu sekme, HTTP isteğine özel başlık bilgileri eklemek için kullanılır. Sunucuya gönderilen verinin türünü, kabul edilen veri biçimlerini veya kimlik doğrulama gibi özel bilgileri iletmek amacıyla başlıklar tanımlanır.

Veri Tipi:String (Key-Value-Description formatında)

Alanlar:

• Key:Başlık adı. Örneğin, Content-Type, Accept, Authorization.

• Value:Başlık değeri. Örneğin, application/json, application/xml.

• Description:Eklenen başlığın amacıyla ilgili açıklama yazılabilir. Örnek: "Veri JSON formatındadır." veya "İstek yetkilendirmesi için token başlığı."

Body

• Veri Tipi: JSON, XML veya Raw String

• Açıklama: POST, PUT veya PATCH gibi veri gönderen işlemlerde sunucuya gönderilecek veriyi içerir.

• Kullanım Örneği:

{

"name": "gen",

"email": "[e-mail]"

}

Butonlar

• Add: Yeni bir satır (Key-Value çifti) ekler. Parametre, başlık, cookie veya benzeri bilgileri tanımlamak için kullanılır.

• Remove: Seçili satırı siler. Yanlış girilen veya artık kullanılmayan bilgileri kaldırmak için kullanılır.

• Clear: İlgili sekmede tanımlı tüm satırları temizler ve alanı sıfırlar.

Daha fazla detay için buraya da bakabilirsiniz.

Outputs

REST API çağrısı sonucunda elde edilen çıktılar bu sekmede tanımlanır. Çıktılar, sürecin bir sonraki adımında kullanılmak üzere değişkenlere aktarılır.

Data

• Veri Tipi: Text

• Açıklama: API'den dönen ana içeriktir. Genellikle JSON ya da düz metin (plain text) olarak gelir.

Status Code

• Veri Tipi: Number

• Açıklama: İstek sonucunun HTTP durum kodudur. Örnek olarak:

  • 200: Başarılı

  • 400: Hatalı istek

  • 401: Yetkisiz

  • 500: Sunucu hatası

• Kullanım Örneği:

  • StatusCode = 200 kontrolü ile işlem başarı durumu sorgulanabilir.

Cookies

• Veri Tipi: Collection

• Açıklama: API çağrısı sırasında sunucudan dönen çerez bilgilerini içerir.

• Kullanım Örneği:

  • Kimlik doğrulama veya oturum takibi için dönen cookie verileri burada saklanır ve ileriki adımlarda tekrar kullanılabilir.

Kullanım Örnekleri:

• Bir web API’ye veri göndererek işlem başlatma

• Dış sistemden JSON formatında veri alma

• Yetkilendirme gerektiren servislerle entegrasyon kurma

Kullanım Örneği – REST Servis Çağrısı (Reqres.in üzerinden GET ve POST Örneği)

GenRPA Studio üzerinde REST servis entegrasyonu gerçekleştirirken test amaçlı kullanılabilecek açık kaynak API projelerinden biri olan reqres.in platformu üzerinden servis çağrım süreci aşağıda adım adım açıklanmıştır.

GET Metodu ile Servis Çağırma

• İlk olarak https://reqres.in adresi ziyaret edilir.
• Sol tarafta örnek REST metodları, sağ tarafta ise ilgili endpoint’ler ve örnek cevap yapıları yer almaktadır.

• Üstteki örnek servislerden biri seçilir (örneğin: /api/users?page=2).

• Endpoint bilgisi (örneğin: https://reqres.in/api/users?page=2) kopyalanır.

Örnek Kullanım:

https://www.genrpa.com/download/Activities/SERVICE/Service_RestService.xmlwww.genrpa.com