BuKurye API Reference

Genel Bilgiler

Nasıl Çalışır

Bukurye Api'nin pratik bir authentication yapısı bulunur. Api'ye bu authentication yapısını kullanarak nasıl bağlanacağınızı bu sayfadan öğrenebilirsiniz.

Api'ye bütün istekler HTTP POST parametreleri ile gönderilir. Parametrelerin çoğu için bir format kısıtlaması yoktur ancak genellikle array parametrelerin JSON formatında gönderilmesi istenir. Bu durum ilgili fonksiyonlarda özel olarak belirtilecektir.

Api'ye authentication ile bağlantı sağladıktan sonra kullanıcı girişi (user_auth almalısınız) yapmalısınız. Kullanıcı girişi işlemleri get_user_auth sayfasında açıklanmaktadır.

Bir sonraki adım olarak get_locations fonksiyonunu kullanarak gönderim yapabileceğiniz mahallelerin id'lerini almalısınız. Kendi sisteminizde BuKurye mahalle_id'leri kendi sisteminizdeki adresleri eşleştirecek bir sistem oluşturmalısınız.

get_locations fonksiyonu ile gonderim yapilacak mahallelerin id bilgilerini aldiktan sonra, uygun gonderi sekillerini ve gonderi fiyatlarini get_offers fonksiyonu ile elde edebilirsiniz

get_offers icerisinde gelen tekliflerden sizin icin uygun olani (boyut, hız, fiyat) seçerek ilgili offer_id ile create_order fonksiyonunu kullanarak gönderi talebi oluşturursunuz.

Son adım olarak ödeme gerçekleştirmeli ve gönderinizi onaylamalısınız. create_order sonucunda dönen order_id ile make_payment fonksiyonuna istek gönderdiğinizde ödemeniz alınacak ve gönderi talebiniz onaylanacaktır.

Onaylanan gönderinizin durumunu get_order ve get_order_events fonksiyonları ile takip edebilirsiniz.

Başarılı İşlemler

Her işlem json formatlı response ve data değişkenlerini geri gönderir. Başarılı api talepleri her zaman code 200 ile geri döner. status her zaman success ile ifade edilir.

    "response": {
        "status": "success",
        "code": 200,
        "message": "OK"
    },
    "data": {}

Başarısız İşlemler

Başarısız api talepleri değişik hata kodları ve mesajları ile geri döner. status her zaman error ile ifade edilir.


    "response": {
        "status": "error",
        "code": 404,
        "message": "Kayıt Bulunamadı"
    },
    "data": {}