Worldwide (English)
Türkiye (Türkçe)
BaşlangıçYapı ve Format
Harici ve dahili API istekleriyle ilgili yapı ve format bilgileri aşağıda detaylı olarak açıklanmıştır.
Harici API Formatı
- API isteği gönderirken, talebin "Header" kısmındaki "Content-Type" başlığının "application/json" olarak belirlenmesi gereklidir.
- Eğer istek veri seti göndermeyi gerektiriyorsa, bu veri setinin JSON formatında olmasını sağlayınız.
- API'den alınacak yanıt JSON formatında olup, HTTP durum kodu her zaman 200 olarak dönecektir.
Dahili API Formatı
- Dahili API için gerçekleştirilecek işlemlerle alakalı veri setini dizi (Array) formatında iletmelisiniz.
- API'den alınacak yanıt da aynı biçimde dizi (Array) formatında olacaktır.
Yanıt Gövdesi
Aşağıda, hem harici hem de dahili API kullanımında alınacak yanıtların içeriğine dair detaylar bulunmaktadır.
| Alan | Türü | Açıklama |
|---|---|---|
| status | String | Eylemin durumu ile ilgili bilgi verir. Bu bilgi "error" içeriyorsa eylem başarısız, "successful" içeriyorsa eylem başarılı demektir. |
| message | String | Eylemin "status" alanı "error" içeriyorsa, hata mesajı ile ilgili bilgi verir. |
| data | Dahili: Array Harici: Object |
Eylemin başarılı olması durumunda içerisinde eylem ile ilgili bilgiler verir. |
Hatalı Yanıt Örneği (JSON)
{
"status": "error",
"message": "Credentials do not match"
}Başarılı Yanıt Örneği (JSON)
{
"status": "successful",
"data": {
"user_id": 19,
"hash": "ZmozNFdUNy8wMGM4bkVKK01IeUF5d2tSNzU0d1E1VThLZUJmZXNzdVNkK2dvWEgwdmdOTDE4YldmMzFCTVdheVY3bjhRTDBxSVNOb1FXcjBhVEhiTlE9PQ=="
}
}Log Kaydı
Hem harici hem de dahili API yoluyla yapılan tüm istekler sistem tarafından otomatik olarak kaydedilmektedir.
Bu kayıtlara erişmek için, yönetim panelinin menüsünden şu adımları takip edebilirsiniz:
- "Ayarlar" menüsüne gidin.
- "Genel Ayarlar" alt başlığına tıklayın.
- Açılan sayfadan "API" sekmesine tıklayın.
- Karşınıza çıkan "Kayıtlar" sekmesi aracılığıyla API istek kayıtlarına ulaşabilirsiniz.
