Genel Bakış

Temel Kavramlar

posentegra'nın veri modeli dört katmanda kuruluyor; entegrasyonu yazmadan önce bu kavramların birbirine nasıl bağlandığını bilmek gerekiyor.

Hiyerarşi

posentegra'da kayıtlar tek bir zincir üzerinden birbirine bağlanır: hesabınızdan başlayıp sipariş kaydına kadar iner.

Hiyerarşi

hiyerarşi

Hesap (API anahtarı)
└── İşletme              /web-api/v1/businesses
    └── Restoran         /web-api/v1/businesses/{businessId}/restaurants
        ├── Entegrasyon  /web-api/v1/restaurants/{restaurantId}/integrations
        ├── Paket        /web-api/v1/restaurants/{restaurantId}/packages
        └── Sipariş      /web-api/v1/orders

İşletme

İşletme, hesabınızın en üst seviyedeki kaydıdır. Restoranlar bir işletmeye bağlanır. İlgili uçlar: GET|POST /web-api/v1/businesses ve GET|PUT|DELETE /web-api/v1/businesses/{businessId}. Ayrıntılar için İşletmeler API'si sayfasına bakın.

Alan	Tip	Zorunlu	Not
id	string	—	Yanıtta dönen kayıt kimliği
name	string	Evet	İşletme adı
address	string	—	Açık adres
phone	string	—	İletişim telefonu
email	string	—	İletişim e-postası

İlgili uç noktalar: Tüm İşletmeleri Getir, İşletme Oluştur, İşletme Detayını Getir.

Restoran

Restoran, sipariş alan fiziksel şubedir. Entegrasyonlar ve paketler restoran seviyesinde tanımlanır — yani bir işletmenin iki şubesi farklı platformlara bağlı olabilir. Ayrıntılar için Restoranlar API'si sayfasına bakın.

Alan	Tip	Zorunlu	Not
id	string	—	Yanıtta dönen kayıt kimliği
businessId	string	—	Bağlı olduğu işletme
name	string	Evet	Restoran adı
address	string	—	Şube adresi
config	object	—	Platforma özel serbest biçimli ayar nesnesi

İlgili uç noktalar: Restoran Oluştur, Restoran Detayını Getir, Mevcut Restoranı İşletmeye Bağla.

Entegrasyon

Entegrasyon, bir restoranı bir yemek platformuna bağlayan kayıttır. Durumu POST /web-api/v1/restaurants/integrations/update-status ucuyla açılıp kapatılır. Ayrıntılar için Entegrasyonlar API'si sayfasına bakın.

providerId — hangi platform entegrasyonunun güncelleneceğini belirtir
status (boolean) — entegrasyonu açar veya kapatır
config (object) — restaurantId, apiKey, secretKey, supplierId gibi platforma özel kimlik bilgilerini taşır

İlgili uç noktalar: Restoran Entegrasyonu Ekle veya Güncelle, Restoran Entegrasyonlarını Listele.

Sipariş

Sipariş, bağlı platformdan düşen kayıttır. Yaşam döngüsü doğrulamayla başlar (POST /web-api/v1/orders/verify/{orderId}), durum ilerletmeyle devam eder (POST /web-api/v1/orders/change-status/{orderId}), gerekirse iptalle sonlanır (POST /web-api/v1/orders/cancel/{orderId}); iptal gerekçeleri GET /web-api/v1/orders/reasons/{orderId} ucundan alınır. Ayrıntılar için Sipariş Akışı rehberine bakın.

Alan	Tip	Zorunlu	Not
id	string	—	Sipariş kaydının kimliği
providerOrderId	string	—	Platformdaki orijinal sipariş kimliği
restaurantId	string	—	Siparişin düştüğü restoran
reason	string	—	İptalde gönderilen neden kodu

İlgili uç noktalar: Siparişleri Listele, Sipariş Detayı.

Paket

Paket, restorana atanan kullanım paketidir; hesap bakiyesi bu seviyede tutulur. İlgili uçlar: GET /web-api/v1/user/packages, GET /web-api/v1/user/packages/available ve POST /web-api/v1/restaurants/{restaurantId}/assign-package. Ayrıntılar için Paketler API'si sayfasına bakın.

Alan	Tip	Zorunlu	Not
userPackageId	string	Evet	Restorana atanacak paketin kimliği
packageId	string	—	Paket tipinin kimliği
quantity	number	—	Kalan kullanım adedi
businessName	string	—	Paketin görüneceği işletme adı

İlgili uç noktalar: Restorana Paket Ata, Restoran Paketlerini Listele.

API anahtarı

API anahtarı hesap seviyesindedir ve hesabınıza bağlı tüm işletme ve restoranları kapsar. Authorization başlığında üç biçimden biriyle gönderilebilir: X-Api-Key, Authorization: Bearer <api-key> ya da Authorization: <api-key>. Ayrıntılar için Kimlik Doğrulama sayfasına bakın.

Authorization / X-Api-Key — API anahtarını taşır, üç kabul edilen biçimden biriyle gönderilir

İlgili uç noktalar: Webhooks sayfasında istek doğrulaması anlatılır.

Kimlik Doğrulama

API anahtarınızı nasıl göndereceğinizi öğrenin.

İlk Entegrasyon

Sıfırdan sipariş alır hâle gelmenin en kısa yolu.

API Referansı

Tüm uç noktaların tam listesi.