Genel API · v1

Geliştirici Dokümantasyonu

Restoranın menüsünü ve siparişlerini kendi yazılımınıza bağlayın. REST, JSON, API anahtarı ile kimlik doğrulama.

https://kuryolopos.com/api/v1OpenAPI tanımı (JSON)

Başlangıç

KuryoloPOS panelinde Geliştirici / API sayfasını açın.
Bir API anahtarı oluşturun ve gereken yetki kapsamlarını seçin.
Anahtar yalnızca oluşturulurken bir kez gösterilir; güvenli bir yere kaydedin.
Her isteğe X-Api-Key başlığını ekleyin.

curl https://kuryolopos.com/api/v1/menu \
  -H "X-Api-Key: SIZIN_ANAHTARINIZ"

Kimlik doğrulama

Kimlik doğrulama X-Api-Key başlığı ile yapılır. Anahtar hangi restorana ait olduğunu da taşır; ayrıca restoran kimliği göndermenize gerek yoktur ve bir anahtarla yalnızca kendi restoranınızın verisine erişebilirsiniz.

GET /api/v1/orders?status=NEW HTTP/1.1
Host: kuryolopos.com
X-Api-Key: SIZIN_ANAHTARINIZ

Yetki kapsamları

Her anahtar yalnızca kendisine verilen kapsamlarda işlem yapabilir. Okuma uçları için ek kapsam gerekmez; yazma yapan uçlar açıkça kapsam ister.

orders:writeSipariş durumunu güncellemeye izin verir.

İstek sınırı

Anahtar başına dakikada 120 istek. Sınır aşıldığında429 döner. Menü gibi seyrek değişen verileri kendi tarafınızda önbelleğe almanızı öneririz.

Hata kodları

Kod	Anlamı
401	X-Api-Key başlığı yok, ya da anahtar geçersiz veya iptal edilmiş.
403	Anahtarın bu işlem için gereken yetki kapsamı yok.
400	Geçersiz istek — örneğin tanımsız bir sipariş durumu gönderildi.
404	Kayıt bulunamadı ya da bu anahtara ait değil.
429	İstek sınırı aşıldı.

Uç referansı

Bu liste API tanımından otomatik üretilir; kodda değişen her uç burada da değişir.

GET/api/v1/menu

Aktif menü (kategoriler + ürünler)

GET/api/v1/orders

Sipariş listesi (sayfalı)

Parametre	Yer	Zorunlu
status	sorgu	hayır
orderType	sorgu	hayır
page	sorgu	hayır
limit	sorgu	hayır
from	sorgu	hayır
to	sorgu	hayır

GET/api/v1/orders/{id}

Sipariş detayı

Parametre	Yer	Zorunlu
id	yol	evet

PATCH/api/v1/orders/{id}/statusorders:write gerekli

Sipariş durumunu güncelle

Parametre	Yer	Zorunlu
id	yol	evet

Webhook

Sipariş olaylarını sürekli sorgulamak yerine anlık bildirim alabilirsiniz. Panelin Geliştirici / API sayfasından bir adres tanımlarsınız; olaylar imzalı olarak gönderilir. İmzayı doğrulayarak isteğin gerçekten KuryoloPOS'tan geldiğini teyit edin.

Kapsam dışı

Bugünkü sürümde genel API okuma ve sipariş durumu güncelleme ile sınırlıdır. Dışarıdan sipariş oluşturma bilinçli olarak kapalıdır: kasada karşılığı olmayan bir adisyonun dışarıdan açılması, ciro ve stok kayıtlarını sessizce bozar.

Pazaryeri siparişleri (Yemeksepeti, Getir, Trendyol) için ayrı bir entegrasyon yolu vardır; panelin Pazaryeri bölümünden bağlanır. Kurye firması bağlantısı da benzer şekilde ayrıdır.

Bir uç eksik mi?

İhtiyacınız olan veriyi API üzerinden alamıyorsanız bize yazın; entegrasyon ihtiyaçlarına göre kapsamı genişletiyoruz.