API Referansı

Genel Bakış

Tüm istekler https://api.v1.fastsiparis.com taban adresine yapılır. Sürüm bilgisi yolun içindedir: bu referanstaki her uç nokta /web-api/v1 ile başlayan tam yoluyla yazılmıştır, taban adresle birleştirirken tekrar eklemeyin.

Taban URL

taban url

https://api.v1.fastsiparis.com

Bu referans, yayımlanan OpenAPI tanımının (v1.0.1) 23 operasyonunun tamamını kapsar. Ek olarak, tanımda henüz yer almayan 7 uç nokta daha belgelendi: üç entegrasyon ucu, orders/retry-webhook, orders/grouped-payments, providers/migros/menus ve bir işletmenin restoranlarını listeleyen uç. Bunlar canlıda çalışıyor ancak tanıma girmediği için alanları tanım dosyasından doğrulanamaz.

Kimlik doğrulama

Tüm istekler Authorization: Bearer POSENTEGRA_API_KEY başlığını gerektirir. Ayrıntılar için Kimlik Doğrulama sayfasına bakın.

Üç başlık biçiminin tümü kabul edilir:

Biçim	Örnek	Not
Authorization: Bearer <api-key>	Authorization: Bearer POSENTEGRA_API_KEY	Önerilen.
X-Api-Key	X-Api-Key: POSENTEGRA_API_KEY
Authorization: <api-key>	Authorization: POSENTEGRA_API_KEY

Uç nokta grupları

İşletmeler (6)

İşletme, hesabınızın en üst seviyedeki kaydıdır. Restoranlar bir işletmeye bağlanır.

Restoranlar (7)

Sipariş alan fiziksel şubeler. Entegrasyonlar ve paketler restoran seviyesinde tanımlanır.

Siparişler (10)

Bağlı platformlardan düşen siparişlerin listelenmesi, durum ilerletme ve iptal akışı.

Paketler (4)

Restoranlara atanan kullanım paketleri ve hesap bakiyeleri.

Entegrasyonlar (3)

Restoranın bağlı olduğu platformların eklenmesi, listelenmesi ve durum güncellemesi.