API
Ek$igator, bu altyapıyı kullanarak kendi uygulamalarını geliştirmek isteyen yazılım geliştiriciler için
bir JSONP API sunar. Belirtilen API adresine yapılan HTTP isteklerinden donen JSON verilerini kendi uygulamanızda kullanabilirsiniz.
API iki ana işlem içerir :
1 - Kimlik Doğrulama
API komutlarını kullanabilmek için, kullanıcının giriş yaptırılması gerekmektedir.
Bunun için belirtilen API adresine /eposta@adresi.com/API_Anahtarı/ şeklinde bir istek göndermelisiniz.
Örneğin,
http://api.eksigator.com/
olarak belirtilen API adresine
http://api.eksigator.com/foo@bar.com/785e8695f2a951d2d566d2abe66a665b/
şeklinde istek göndermelisiniz.
Eğer belirtilen e-posta adresi ve API anahtarı sistemde bulunmuyorsa
{"message":"AUTH_FAILED"}
şeklinde bir JSON verisi dönecektir. Eğer giriş başarılı ise herhangi bir mesaj dönmeyecektir.
2 - Komutlar
Bu komutları ve parametreleri "Kimlik Doğrulama" bölümünde eklenen parametrelerden sonra eklemelisiniz.
Örn : http://api.eksigator.com/foo@bar.com/785e8695f2a951d2d566d2abe66a665b/komut/parametre
| İşlem | Komut | Parametre |
|---|---|---|
| Listeyi almak | getList | |
| Listeye başlık eklemek | addToList | başlık |
| Listeden başlık çıkarmak | removeFromList | başlık |
| Başlığı okundu olarak işaretlemek | setItemAsRead | başlık |
{
"title": "avatar",
"lastRead": "1261694100",
"status": "1",
"lastId": "17604247"
}
Burada "title" başlığı, "lastRead" son okunduğu zamanın Unix Timestamp karşlığı, "status" okunup okunmadığını, "lastId" ise son okunan entry numarasını bildirir.
