Ganipara REST API v1.0 Dokümantasyonu

Anasayfa/ API/ REST API v1.0

Ganipara Rest API v1.0

Web Kancaları

Ganipara.com mağazanızda gerçekleşen sipariş vb gibi çeşitli olaylar sonrası Ganipara.com sisteminin 3.parti bir uygulamayı bilgilendirmesi, veri göndermesi için “Web Kancaları” özelliğini kullanabilirsiniz. Web kancaları ile gönderilen verilen JSON formatında gönderilmektedir.

Veri şemasını ve örnek verileri görmek için buraya tıklayın

Methodlar

Web kancası detayları Detay
Web kancalarını say Detay
Web kancalarını listele Detay
Web kancası oluştur Detay
Web kancasını güncelle Detay
Web kancasını sil Detay

Webhook detay

https://api.ganipara.com/1.0/webhook/detail/ GET
Web kancası detayları
Paremetre Tür Zorunlu
id Web Kancasının ID'si Sayı Evet 
GET /1.0/webhook/detail/

{
   "id":"1717"
}

{
   "status":true,
   "webhook":{
      "id":"1717",
      "url":"http:\/\/alanadi.com\/webkancasi_yakala.php",
      "event":"product_create",
      "name":"Sipariş'i CRM'e ekle"
      "create_date":"2013-12-03T21:14:32+0100",
      "method":"POST",
      "update_date":"-0001-11-30T00:00:00+0100"
   }
}

Webhook say

https://api.ganipara.com/1.0/webhook/count/ GET
Web kancası sayısı
Paremetre Tür Zorunlu
event Web webkancası hangi olayda tetiklensin order_complete: Sipariş Tamamlandı order_delete: Sipariş Silindi order_update: Sipariş Güncellendi order_cancelled: Sipariş İptal Edildi product_create: Ürün Oluşturuldu product_update: Ürün Güncellendi product_delete: Ürün Silindi collection_create: Katalog Oluşturuldu collection_update: Katalog Güncellendi collection_delete: Katalog Silindi Metin Hayır
url Veri hangi adresi gönderilsin Metin Hayır
date_start Başlangıç tarihi (ISO 8601 formatında) Tarih Hayır
date_end Bitiş tarihi (ISO 8601 formatında) Tarih Hayır 
GET /1.0/webhook/count/

{
   "event":"product_create"
}

{
   "status":true,
   "count":12
}

Webhook listele

https://api.ganipara.com/1.0/webhook/list/ GET
Web kancalarını listele
Paremetre Tür Zorunlu
event Web webkancası hangi olayda tetiklensin order_complete: Sipariş Tamamlandı order_delete: Sipariş Silindi order_update: Sipariş Güncellendi order_cancelled: Sipariş İptal Edildi product_create: Ürün Oluşturuldu product_update: Ürün Güncellendi product_delete: Ürün Silindi collection_create: Katalog Oluşturuldu collection_update: Katalog Güncellendi collection_delete: Katalog Silindi Metin Hayır
url Veri hangi adresi gönderilsin Metin Hayır
date_start Başlangıç tarihi (ISO 8601 formatında) Tarih Hayır
date_end Bitiş tarihi (ISO 8601 formatında) Tarih Hayır
limit Sayfa başına listenecek kayıt sayısı (10, 25, 50) Sayı Hayır
page Listenecek sayfa Sayı Hayır 
GET /1.0/webhook/list/

{
   "event":"product_create",
   "limit":"50",
   "page":"1"
}

{
   "status":true,
   "webhooks":[
      {
         "id":"31",
         "url":"http:\/\/postcatcher.in\/catchers\/2349b4dc50341200200000751",
         "event":"order_delete",
         "name":"Test 1",
         "create_date":"2013-12-03T21:13:32+0100",
         "method":"POST",
         "update_date":"-0001-11-30T00:00:00+0100"
      },
      {
         "id":"30",
         "url":"http:\/\/postcatcher.in\/catchers\/529b4dc50341200200000753",
         "event":"collection_create",
         "name":"Test 2",
         "create_date":"2013-12-01T15:59:12+0100",
         "method":"POST",
         "update_date":"-0001-11-30T00:00:00+0100"
      }
   ],
   "_metadata": {
        "page": 1,
        "limit": 50,
        "page_count": 1,
        "total_count": 6
    }
}

Webhook oluştur

https://api.ganipara.com/1.0/webhook/create/ POST
Yeni bir web kancası eklemek
Paremetre Tür Zorunlu
event Web webkancası hangi olayda tetiklensin order_complete: Sipariş Tamamlandı order_delete: Sipariş Silindi order_update: Sipariş Güncellendi order_cancelled: Sipariş İptal Edildi product_create: Ürün Oluşturuldu product_update: Ürün Güncellendi product_delete: Ürün Silindi collection_create: Katalog Oluşturuldu collection_update: Katalog Güncellendi collection_delete: Katalog Silindi Metin Evet
url Veri hangi adresi gönderilsin Metin Evet
name Ad Metin Hayır 
POST /1.0/webhook/create/

{
   "event":"product_create",
   "url":"http://alanadi.com/webkancasi_yakala.php",
   "name":"Sipariş'i CRM'e ekle"
}

{
   "status":true,
   "webhook":{
      "id":"1717",
      "url":"http:\/\/alanadi.com\/webkancasi_yakala.php",
      "event":"product_create",
      "name":"Sipariş'i CRM'e ekle"
      "create_date":"2013-12-03T21:14:32+0100",
      "method":"POST",
      "update_date":"-0001-11-30T00:00:00+0100"
   }
}

Webhook güncelle

https://api.ganipara.com/1.0/webhook/update/ POST
Web kancasını güncellemek
Paremetre Tür Zorunlu
id Web kancasının ID değeri Sayı Evet
event Web webkancası hangi olayda tetiklensin order_complete: Sipariş Tamamlandı order_delete: Sipariş Silindi order_update: Sipariş Güncellendi order_cancelled: Sipariş İptal Edildi product_create: Ürün Oluşturuldu product_update: Ürün Güncellendi product_delete: Ürün Silindi collection_create: Katalog Oluşturuldu collection_update: Katalog Güncellendi collection_delete: Katalog Silindi Metin Hayır
url Veri hangi adresi gönderilsin Metin Hayır
name Ad Metin Hayır 
POST /1.0/webhook/update/

{
   "id":"1717",
   "name":"Sipariş'i Siteme ekle"
}

{
   "status":true,
   "webhook":{
      "id":"1717",
      "url":"http:\/\/alanadi.com\/webkancasi_yakala.php",
      "event":"product_create",
      "name":"Sipariş'i Siteme ekle",
      "create_date":"2013-12-03T21:14:32+0100",
      "method":"POST",
      "update_date":"-0001-11-30T00:00:00+0100"
   }
}

Webhook sil

https://api.ganipara.com/1.0/webhook/delete/ POST
Web kancasını silmek
Paremetre Tür Zorunlu
id Web kancasının ID değeri Sayı Evet 
POST /1.0/webhook/delete/

{
   "id":"1717"
}

{
   "status":true,
   "id":"1717"
}

Web Kancası Örnek Veriler

Ganipara Web Kancaları ile gönderilen veriler aşağıda formatta gönderilmektedir.

Web kancaları hakkında bilgi almak için buraya tıklayınız.

Web kancaları API ile yapılan işlemlerde tetiklenmez.

Mağaza güncellendi

Mağaza Güncellendi shop_update 
{
   "webhook_event":"shop_update",
   "user_id":"317",
   "data":{
      "id":"317",
      "email":"aysegul@alanadi.com",
      "shop_id":"ankara",
      "first_name":"Ayşegül",
      "last_name":"Nazlı",
      "address":"Sümer 2.Sok No:36/2 Kızılay",
      "city":"Ankara",
      "city_code":"6",
      "currency":"TRY",
      "domain":"ankara.ganipara.com",
      "domain_primary":"magaza.alanadi.com",
      "title":"Ev ve Ofis için tasarım ürünler",
      "description":"Evinizi ve ofisinizi tasarım ürünlerimiz ile keyifli hale getirin",
      "keywords":"ev,ofis,tasarım,dekoratif,el yapımı"
   }
}

Sipariş oluşturuldu

Sipariş Oluşturuldu order_create 
{
  "webhook_event": "order_create",
  "user_id": "317",
  "data": {
    "id": "1749",
    "order_number": "SIPARIS-CHYJN-AC23S-HNJH61213",
    "order_date": "2013-12-06T12:29:12+0100",
    "ip": "198.167.2.12",
    "transaction_id": "3250",
    "status": "complete",
    "payment_type": "creditcard",
    "payatdoor_type": "cash",
    // Sadece Kapıda Ödeme seçeneğinde belirtilir.
    "gateway": "iyzico",
    "buyer": {
      "name": "Ayşegül Nazlı",
      "email": "aysegul@alanadi.com",
      "phone": "(532) 1111111"
    },
    "note": "",
    "currency": "TRY",
    "amount": "393.00",
    "amount_subtotal": "300.00",
    "amount_cargo": "90.00",
    "amount_giftwrap": "3.00",
    "amount_gateway": "10.00",
    "amount_discount": "-10.00",
    "amount_installment": "0.00",
    "billing": {
      "type": "personal",
      "name": "Ayşegül Nazlı",
      "address": "Sümer 2.Sok No:36/2 Kızılay",
      "city": "Ankara",
      "town": "Çankaya",
      "country": "TR",
      "state": "",
      "zipcode": "06650"
    },
    "shipping": {
      "name": "Berkay UNAL",
      "address": "Sümer 2.Sok No:36/2 Kızılay",
      "city": "Ankara",
      "town": "Çankaya",
      "country": "TR",
      "zipcode": ""
    },
    "shipping_rate": {
      "id": "186",
      "title": "Standart Kargo",
      "description": "",
      "courier_id_default": "32"
    },
    "has_download": false,
    "items": [
      {
        "id": "171089",
        "product_id": "534059",
        "url": "http://shop.alanadi.com/product/detail/urun-1",
        "name": "Ürün 1",
        "sub_name": "",
        "sub_name_keys": "",
        "sku": "2.57C.F8D.A6F7",
        "gtin": null,
        "type": "product",
        "product_type": "tangible",
        "unit_price": "100.00",
        "quantity": 1,
        "quantity_type": "integer",
        "total_price": "100.00",
        "status": "ready",
        "photo": "https://cdn-merchant.ganipara.home/assets/1321/product/14123/large_il_fullxfull.jpg"
      },
      {
        "id": "171090",
        "product_id": "534058",
        "url": "http://shop.alanadi.com/product/detail/urun-2",
        "name": "Ürün 2",
        "sub_name": "M",
        "sub_name_keys": "Beden",
        "sku": "2.57C.EA0.0DF1",
        "gtin": null,
        "type": "product",
        "product_type": "tangible",
        "unit_price": "100.00",
        "quantity": 1,
        "quantity_type": "integer",
        "total_price": "100.00",
        "status": "ready",
        "photo": ""
      },
      {
        "id": "171091",
        "product_id": "534057",
        "url": "http://shop.alanadi.com/product/detail/urun-3",
        "name": "Ürün 3",
        "sub_name": "",
        "sub_name_keys": "",
        "sku": "2.57C.D41.01C9",
        "gtin": null,
        "type": "product",
        "product_type": "tangible",
        "unit_price": "100.00",
        "quantity": 1,
        "quantity_type": "integer",
        "total_price": "100.00",
        "status": "ready",
        "photo": ""
      }
    ],
    "product_ids": [
      "534059",
      "534058",
      "534057"
    ],
    "invoice_data": {
      "title": "Ayşegül Nazlı",
      "tax_number": "",
      "tax_office": "",
      "address": "Sümer 2.Sok No:36/2 Kızılay Çankaya Ankara/Türkiye",
      "items": [
        {
          "line_type": "product",
          "name": "Ürün 1",
          "sub_name": "",
          "sub_name_keys": "",
          "product_id": "534059",
          "sku": "2.57C.F8D.A6F7",
          "gtin": "",
          "quantity": 1,
          "quantity_type": "integer",
          "photo": "https://cdn-merchant.ganipara.home/assets/1321/product/14123/large_il_fullxfull.jpg",
          "vat_rate": "1",
          "unit_price": {
            "with_vat": 100,
            "without_vat": 99.01,
            "vat_amount": 0.98999999999999
          },
          "total_price": {
            "with_vat": 100,
            "without_vat": 99.01,
            "vat_amount": 0.98999999999999
          }
        },
        {
          "line_type": "product",
          "name": "Ürün 2",
          "sub_name": "M",
          "sub_name_keys": "Beden",
          "product_id": "534058",
          "sku": "2.57C.EA0.0DF1",
          "gtin": "",
          "quantity": 1,
          "quantity_type": "integer",
          "photo": "",
          "vat_rate": "18",
          "unit_price": {
            "with_vat": 100,
            "without_vat": 84.75,
            "vat_amount": 15.25
          },
          "total_price": {
            "with_vat": 100,
            "without_vat": 84.75,
            "vat_amount": 15.25
          }
        },
        {
          "line_type": "product",
          "name": "Ürün 3",
          "sub_name": "",
          "sub_name_keys": "",
          "product_id": "534057",
          "sku": "2.57C.D41.01C9",
          "gtin": "",
          "quantity": 1,
          "quantity_type": "integer",
          "photo": "",
          "vat_rate": "8",
          "unit_price": {
            "with_vat": 100,
            "without_vat": 92.59,
            "vat_amount": 7.41
          },
          "total_price": {
            "with_vat": 100,
            "without_vat": 92.59,
            "vat_amount": 7.41
          }
        },
        {
          "line_type": "cargo",
          "name": "Kargo ücreti",
          "sub_name": "",
          "sub_name_keys": "",
          "product_id": "",
          "sku": "",
          "gtin": "",
          "quantity": "1",
          "quantity_type": "integer",
          "vat_rate": "18",
          "unit_price": {
            "with_vat": 90,
            "without_vat": 76.27,
            "vat_amount": 13.73
          },
          "total_price": {
            "with_vat": 90,
            "without_vat": 76.27,
            "vat_amount": 13.73
          }
        },
        {
          "line_type": "gateway",
          "name": "Ödeme altyapısı komisyon ücreti",
          "sub_name": "",
          "sub_name_keys": "",
          "product_id": "",
          "sku": "",
          "gtin": "",
          "quantity": "1",
          "quantity_type": "integer",
          "vat_rate": "18",
          "unit_price": {
            "with_vat": 10,
            "without_vat": 8.47,
            "vat_amount": 1.53
          },
          "total_price": {
            "with_vat": 10,
            "without_vat": 8.47,
            "vat_amount": 1.53
          }
        },
        {
          "line_type": "giftwrap",
          "name": "Hediye paketi ücreti",
          "sub_name": "",
          "sub_name_keys": "",
          "product_id": "",
          "sku": "",
          "gtin": "",
          "quantity": "1",
          "quantity_type": "integer",
          "vat_rate": "18",
          "unit_price": {
            "with_vat": 3,
            "without_vat": 2.54,
            "vat_amount": 0.46
          },
          "total_price": {
            "with_vat": 3,
            "without_vat": 2.54,
            "vat_amount": 0.46
          }
        }
      ],
      "vat": [
        {
          "rate": 18,
          "amount": 30.97
        },
        {
          "rate": 8,
          "amount": 7.41
        },
        {
          "rate": 1,
          "amount": 0.98
        }
      ],
      "sub_total": 363.63,
      "vat_total": 39.37,
      "discount": "-10.00",
      "grand_total": "393.00"
    },
    "invoice_meta": {
      "invoice_printed": true,
      "invoice_number": "AXXXXXXXXX",
      "invoice_ettn": "88ac31aa-e114-11e8-bf91-14fXXXXXXXX"
    }
  }
}

Ürün oluşturuldu/güncellendi

Ürün Oluşturuldu
Ürün Güncellendi 		product_create
product_update 
{
  "webhook_event": "product_create",
  "user_id": "317",
  "data": {
    "id": "163",
    "slug": "dekoratif-zikzak-yastik",
    "url": "http://ankara.ganipara.com/product/detail/163/dekoratif-zikzak-yastik",
    "type": "tangible",
    "quantity_type": "number",
    "title": "Dekoratif Zikzak Yastık",
    "description": "<p>sadsadsa</p>",
    "excerpt": "Kırmızı Dekoratif Zikzik Yastık",
    "visibility": "show",
    "variant_count": 1,
    "variants": [
      {
        "name": "Kırmızı Dekoratif Zikzik Yastık",
        "variant_id": "AUAH700930",
        "price": "100.00",
        "stock": 30,
        "cargo": "2",
        "sku": null,
        "gtin": null
      }
    ],
    "price_avg": "100.00",
    "price_min": "100.00",
    "price_max": "100.00",
    "is_discount": false,
    "tags": false,
    "is_photo": true,
    "photos": [
      {
        "photo_id": "133",
        "base_url": "http://cdn-merchant.ganipara.com",
        "path": "/assets/2/product/163/",
        "filename": "resim1.JPG",
        "alt": "Zikzak Yastık Önden Görünüm",
        "sort_order": 0
      },
      {
        "photo_id": "134",
        "base_url": "http://cdn-merchant.ganipara.com",
        "path": "/assets/2/product/163/",
        "filename": "resim2.JPG",
        "alt": "",
        "sort_order": 1
      }
    ],
    "photo": {
      "photo_id": "133",
      "base_url": "http://cdn-merchant.ganipara.co",
      "path": "/assets/2/product/163/",
      "filename": "resim1.JPG",
      "alt": "Zikzak Yastık Önden Görünüm",
      "sort_order": 0
    },
    "collections": [
      {
        "id": "37"
      }
    ],
    "meta": {
      "title": "Artive Dekoratif Yastık - Zikzak - Kırmızı - Yastık",
      "description": "Ev ve ofisiniz için dekoratif yastık"
    },
    "date_created": "2013-09-30T13:13:29+0200",
    "date_updated": "2013-09-30T13:13:29+0200"
  }
}

Ürün silindi

Ürün Silindi
 product_delete 
{
   "webhook_event":"product_delete",
   "user_id":"317",
   "data":{
      "id":"2245"
   }
}

Katalog oluşturuldu

Katalog Oluşturuldu
Katalog Güncellendi 		collection_update
collection_create 
{
   "webhook_event":"collection_create",
   "user_id":"317",
   "data":{
      "id":"1234",
      "title":"İndirimdeki Ürünler",
      "description":"Bu fiyatları kaçırmayın",
      "slug":"discount",
      "products":[
         {
            "id":"53"
         },
         {
            "id":"222"
         },
         {
            "id":"245"
         }
      ],
      "meta":{
         "title":"SEO meta başlığı",
         "description":"SEO meta açıklaması"
      },
      "date_created":"2013-04-17T23:03:02+0200",
      "date_updated":"2013-12-01T14:09:52+0200"
   }
}

Katalog silindi

Katalog Silindi
 collection_delete 
{
   "webhook_event":"collection_delete",
   "user_id":"317",
   "data":{
      "id":"1234"
   }
}

Sayfa oluşturuldu

Sayfa Oluşturuldu
Sayfa Güncellendi 		page_update
page_create 
{
   "webhook_event":"page_create",
   "user_id":"317",
   "data":{
      "id":"6103",
      "title":"Test Sayfasi",
      "content":"Sayfa içeriği",
      "slug":"test-sayfasi",
      "date_created":"2013-12-06T10:11:24+0100",
      "date_updated":"2013-12-06T10:11:24+0100",
      "published":true,
      "meta":{
         "title":"SEO meta başlığı",
         "description":"SEO meta açıklaması"
      }
   }
}

Sayfa silindi

Sayfa Silindi
 page_delete 
{
   "webhook_event":"page_delete",
   "user_id":"317",
   "data":{
      "id":"6103"
   }
}

API Referansı

Anasayfa

Mağaza

Ürün

Sipariş

Katalog

Sayfa

Kargo

Web Kancası

  • Ganipara alışveriş sitesi açmak için en iyi çözüm. Tavsiye ederim

    Melike

  • Ürünlerimi internetten satmak için ihtiyaç duyduğum tek websitesi

    Orçun

Yukarı