Ofisplan API

Ofisplan API

API yanıtı JSON (Javascript Object Notation) olarak biçimlendirilmiştir. JSON nesnesi, bir Javascript nesnesine benzer. Her özellik ve değer, aşağıdaki gibi çift tırnak işaretleri arasına alınmalıdır:

{
"property1": "value1",
"property2": "value2",
"property3": "value3"
}

{
"özellik1": "değer1",
"özellik2": "değer2",
"özellik3": "değer3"
}



API ile etkileşim

Ofisplan API, URL, cURL gibi komut satırı araçları veya Postman (https://www.postman.com/) gibi yazılımlar aracılığıyla etkileşime girebilir. GET komutları doğrudan bir URL ile çalışabilir, ancak POST, PUT ve DELETE isteklerinin koddan, komut satırından veya Postman gibi bir araçtan çağrılması gerekir.

API'yi etkinleştirmek için proje ayarlarından bir API anahtarı oluşturulmalıdır.

alan adları (fieldname) ve değerleri, URL aracılığıyla veya sorgu parametreleri (Postman'da) olarak aktarılabilir. API anahtarı, URL ile veya bir sorgu parametresi olarak da iletilebilir.

Postman

Sorgu parametreleri olarak API anahtarı:

Sorgu parametreleri olarak yetkilendirme başlığı aracılığıyla API anahtarı:

POST aracılığıyla yeni bir kullanıcı ekleme:

cURL
curl -X GET http://localhost/ofisplan4/MyApiProject/api/Personel?apikey=/w/vq2Xp9KEFXo1sA

curl -X DELETE http://localhost/ofisplan4/MyApiProject/api/Personel/201711300130174407?apikey=/w/vq2Xp9KEFXo1sA

curl -X POST http://localhost/ofisplan4/MyApiProject/api/Personel/?ilkisim=Ali&soyisim=Korkmaz&username=AliKorkmaz&departman=Muhasebe&apikey=/w/vq2Xp9KEFXo1sA 

Önemli Not: Ofisplan'ı farklı dillerde kullanıyorsanız alan tanımlamalarında kullanılan isimlendirmelere dikkat ediniz. (Örnek ilkisim=ilkisim olarak değiştirilmiştir.)

© Copyright 2021 Ofisplan - Her hakkı saklıdır.

This website was built with Mobirise