Bulutfon olarak geliştiricilere API hizmeti sunuyoruz. API v2’yi yayınladık. Bulutfon online işlem merkezi üzerinde yapılan neredeyse tüm işlemleri API v2 ile gerçekleştirebilirsiniz.
API v1’den API v2’yi ayıran özellikler
API v2’de temel olarak üç konu iyileştirilmiştir.
1- API v1’de olmayan yeni 4 adet endpoint eklenmiştir.
2- API v1 santral hizmetine olan abonelerde çalışmaktaydı. API v2 ise tüm abonelerimizde çalışabilmektedir.
3- API v2’de endpoint bazlı yetkilendirme ve birden fazla token kullanabilme imkanı vardır.
Bulutfon API v2’ye Hızlı Bir Bakış
Kimlik Doğrulama ve Yetkilendirme
Yeni versiyonda getirdiğimiz özelliklerden biri birden fazla kullanıcı için “API Kullanıcısı” oluşturabilir ve yönetebilirsiniz.
Bulutfon API kimlik doğrulama için key authentication kullanmaktadır. Yapacağınız isteklere Bulutfon panelinizdeki API Kullanıcıları bölümünden API erişimi olan bir okullanıcı oluşturarak alacağınız apikey’i parametre olarak veya headerda göndermelisiniz.
ÖNEMLİ UYARI : APIv1 ve APIv2 aynı anda çalışmaya devam etmektedir. APIv1’de kullandığınız tokenlar APIv2’de çalışmamaktadır. Yanlış token hatası alıyorsanız. APIv1 tokenı APIv2’de veya tersi bir şekilde kullanım yapıyorsunuzdur.
Filtreleme
Bulutfon API v2’de kayıtlarda filtreleme yapmak için bazı operasyonel işlemlere izin vermekteyiz. Bu işlemlerin neler olduğunu ve nasıl kullanıldığını aşağıdaki tablodan inceleyebilirsiniz. Her model için belirli tablo sütunları filtrelemeye izin verilmektedir. İzin verilen alanları doküman içerisinde ilgili endpointin alanında görebilirsiniz.
| İşlem | Açıklama | Örnek |
|---|---|---|
| cont | İçerir | name[cont]=’Hüse’ |
| eq | Eşit | name[eq]=’Hüseyin’ |
| ne | Eşit Değil | name[ne]=’Hüseyin’ |
| gt | Büyüktür | price[gt]=20 |
| ge | Büyük ya da eşittir | price[ge]=10 |
| lt | Küçüktür | price[lt]=20 |
| le | Küçük ya da eşittir | price[le]=100 |
| in | Verilen dizinin içinde | bf_caller[in]=905068118260,905546028002 |
Sayfalama
Tüm listeleme endpointleri bir sayfalama objesi dönmektedir. Bu obje; mevcut sayfa (page), sayfa başına kayıt sayısı (limit), toplam sayfa (total_pages) ve toplam kayıt (total) olmak üzere 4 değişken içermektedir. Yapacağınız isteklerde page ve limit parametrelerini göndererek dilediğiniz sayfanın getirilmesini sağlayabilir ve sayfa başına gösterilecek kayıt sayısını belirleyebilirsiniz.
"pagination": {
"page": 1,
"limit": 20,
"total": 50,
"total_pages": 3
}Sıralama
Filtrelemede izin verilen tüm alanları belirtilen formatta kayıtları sıralamak için kullanabilirsiniz. Örnek format;
order_by[sütun_adı]=sıralama_şekli(asc veya desc)| Parametre | Açıklama | Örnek |
|---|---|---|
| order_by | Sıralama alanları | order_by[created_at]=asc&order_by[name]=desc\n |
APIv2 ile ilgili yazdığımız örnek makaleler
Bulutfon API sini geliştirmemiz için geri bildirimde bulunun!
Lütfen bizlere daha iyi bir API’yi nasıl yapacağımızı söyleyin, geri bildirimde bulunun. Eğer API’de bir özelliğe ihtiyacınız varsa veya bir hata bulduysanız, lütfen geliştirici formuna konu açın.