İçeriğe geç
Başvuru yap
Dokümantasyon / Başlarken

Nasıl çalışır?

Firma, restoran ve AloYemek arasındaki akış

Entegrasyon üç taraf arasında kurulur: AloYemek, entegrasyon firması (siz) ve restoran. Her restoran bağlantısı ayrı bir anahtarla yapılır; restoran bağlantıyı istediği an kaldırabilir.

1

Başvuru

Firmanız başvuru formunu doldurur, ihtiyaç duyduğu izinleri seçer.

2

Onay

AloYemek başvuruyu inceler; onayda size appSecretKey ve webhook imza anahtarı iletilir.

3

Restoran bağlanır

Restoran panelinde API entegrasyonları sayfasından firmanızı seçer, izinleri onaylar ve restaurantSecretKey oluşturur.

4

Token

POS'unuz iki anahtarla /auth/login çağırır ve 24 saat geçerli token alır.

5

Siparişler akar

Yeni sipariş webhook ile gelir; POS'unuz kabul eder, hazır ve teslim edildi yapar.

Anahtarlar ve kimlikler

AnahtarKimde?Ne işe yarar?
appSecretKey
ayk_app_…
Firma (bir tane)Firmanızı tanımlar. Sunucunuzda saklayın; restorana veya son kullanıcı cihazına koymayın.
restaurantSecretKey
ayk_rst_…
Restoran başına bir taneRestoranın size verdiği yetkidir. Restoran panelinde oluşturulur, POS kurulumunda girilir.
tokenRestoran başına, 24 saatTüm API isteklerinde Authorization: Bearer başlığında gönderilir.
webhookSecret
whsec_…
FirmaSize gelen webhook isteklerinin AloYemek'ten geldiğini doğrulamak içindir.
restaurantIdHerkese açıkRestoranın kalıcı kimliği (uuid). Webhooklarda ve giriş yanıtında döner; kendi sisteminizde eşleştirme için kullanın.

Sipariş akışı

newYeni
→
acceptedHazırlanıyor
→
ready for pickupHazır
→
delivery on its wayYolda
→
delivered / completeTamamlandı

Sipariş her aşamada rejected (red) veya delivery failed (teslim edilemedi) ile kapanabilir. Ayrıntılar ve izin verilen geçişler Sipariş yönetimi sayfasındadır.

Webhook mi, sorgulama mı?

Önerilen yöntem webhook'tur: yeni sipariş birkaç saniye içinde sunucunuza gelir. Webhook adresi olmayan veya yerel ağda çalışan POS'lar /orders/active ucunu 15–30 saniyede bir sorgulayabilir. En sağlam kurgu ikisini birlikte kullanmaktır: webhook ile anında alın, uygulama açılışında ve bağlantı koptuktan sonra aktif siparişleri sorgulayarak eşitleyin.

Sorunuz mu var? destek@aloyemek.com