1.    Yardım Sayfası

Kurulum sonrası, ya da uygulamaya erişmeden önce kurulum dokümanında bahsedilen servislerin çalışır durumda olduğunun testinin yapılması gerekmektedir.

Bu test sonrası servisler çalışır durumda görünüyor ise adresi yardım sayfasına; http://localhost:7070/api/v2/help üzerinden ulaşılabilir. Desteklenen tüm fonksiyon, aldıkları parametre ve nesne tiplerine detaylıca erişilmektedir.

Bu adres üzerinden ihtiyacımız olan kullanılacak API adresleri seçilir. Bu bilgileri kullanacağımız aracımız ise “NetOpenX.Rest.TestApp.exe” nin Operation Sekmesinin ‘Path’ alanıdır.

*NetOpenX.Rest.TestApp.exe, Rest kullanımında verilerin doğru alınıp gönderilebildiğini gözlememizi sağlayan test aracıdır.

2. Methodlar (paket tipleri) ile kullanılabilecek Path (API) örnekleri ve açıklamaları

a) GET

Toplu veri listesi döndürmek ya da tek bir kayıt döndürmek için kullanılır. paket tipi olarak "GET" gönderilmesi gerekmektedir.

Örneğin;

api/v2/ARPs işleminde tüm cari listesini getirirken, api/v2/ARPs/C001 işleminde sadece C001 carisinin bilgilerini getirmektedir.

Toplu veri listesi işlemlerinde limit, sayfalama, sıralama, filtreleme gibi bir çok kısıt yapılabilmektedir:

Limit

http://localhost:7070/api/v2/ARPs?limit=10 her sayfanın kayıtların sayısını belirler. Varsayılan sınır değeri 20'dir.

Sayfalama

http://localhost:7070/api/v2/ARPs?offset=20 sayfalamanın başladığı değerdir. Varsayılan değer 0 dır.

Sıralama

http://localhost:7070/api/v2/ARPs?sort=CARI_KOD ASC şeklinde sıralama yapmaktadır. Birden fazla sıralama verilmesi durumunda ‘,’ ile ayrılmalıdır.

Alanlar

http://localhost:7070/api/v2/ARPs?fields=CARI_KOD,CARI_ISIM sadece belirtilen üst bilgiler döndürülmektedir. Varsayılan değer olarak tüm kolonları döndürmektedir.

İlk Kayıt

http://localhost:7070/api/v2/ARPs?first=true ilk sonuç kümesini getirir.

Son Kayıt

http://localhost:7070/api/v2/ARPs?last=true son sonuç kümesini getirir.

Kısıt

http://localhost:7070/api/v2/ARPs?q=(SQL Select sorgusu) Verilen SQL Select sorgusu sonucu alır. Örnek > ?q=CARI_KOD='J0001'

b) DELETE

Kayıt silme işlemleri olduğunda, paket tipi olarak “Delete” gönderilmesi gerekmektedir.

c) POST

Kayıt eklemek istendiğinde mevcut sınıf değerini paket tipi “POST” olarak şekilde gönderilmesi gerekmektedir. Bilgiler ‘Input’ alana doldurulur.

d) PUT

Kayıt güncelleme işlemlerinde, paket tipi “Put” olarak sadece değişecek sınıf değerlerini göndermek yeterli olacaktır.  Bilgiler ‘Input’ alana doldurulur.

! Rest Servis Erişimi:

Rest üzerindeki “public” işlemler dışındaki diğer fonksiyonlar için “access token” gerekmektedir.