Süper GelsinPartner APIv1.0.0
API Referansı
TREN
Başlangıç
  • Hemen Başla
  • Test Ortamı (Sandbox)
  • Yetkilendirme
  • Servis Limitleri
  • Test hesabı başvurusu
Ortak uçlar
  • İşletme
  • Sipariş Yaşam Döngüsü
  • Sipariş Durumları
  • Mali Belge
  • Kurye Firması Entegrasyonu
  • Müşteri Talepleri
  • Değerlendirmeler
  • Webhook
Yemek
  • Menü ve Ürün Eşleme
Çarşı
  • Çarşı'ya genel bakış
  • Katalog
  • Toplama ve Dönüş
Referans
  • Sürümleme ve Hız Sınırı
  • Hata Kodları ve Sorun Giderme
  • Changelog
  • Sıkça Sorulan Sorular
  • API Referansı
Geliştirici Portalı/Başlangıç

Test Ortamı (Sandbox)

Test hesabı başvurusu ve canlı veriye dokunmadan geliştirme.

Test ortamı canlı ile aynı sürümden çalışır: her canlı yayım aynı anda test ortamını da günceller ve iki ortamın /api/health yanıtı aynı gitSha değerini taşır. Farklı olan yalnız veri ve dış servislerdir. Burada çalışan kod canlıda da çalışır; tek değişiklik taban adres ve anahtardır.

Taban adres ve anahtarlar

Test ortamı
https://sandbox.supergelsin.com/api/partner/v1

Test anahtarları ck_test_, canlı anahtarlar ck_live_ önekiyle başlar. Yanlış ortama gönderilen anahtar 401 environment_mismatch alır ve ileti doğru adresi söyler. Her yanıtta X-Api-Environment başlığı hangi ortama konuştuğunuzu gösterir (sandbox ya da production).

Test hesabı başvurusu

Test hesabı, geliştirici portalındaki başvuru formuyla istenir: Test hesabı başvurusu sayfasında firma adı, e-posta adresi ve isteğe bağlı olarak entegrasyon yazılımının adı girilir. Firma adı X-Integrator başlığında kullanılacak addır: 1–30 karakter; Türkçe karakter içermeyen harf, rakam ve boşluk. Bir IP adresinden saatte en fazla 5 başvuru yapılabilir.

  1. Başvuru alınır. Formda yazar: "Başvurunuz alındı. Onaylandığında e-posta adresinize bir bağlantı gönderilir."
  2. Başvuru yönetimde incelenir ve onaylanır. Reddedilen başvuruya e-posta gönderilmez.
  3. Onaydan sonra e-posta adresinize imzalı bir bağlantı gönderilir. Bağlantı 24 saat geçerlidir.
  4. Bağlantı test ortamında hesabı açar ve anahtarları bir kez gösterir. Sayfa yeniden açılamaz; apiSecret değerlerini hemen kaydedin.
Anahtar sayfasındaki bilgiler
{
  "baseUrl": "https://sandbox.supergelsin.com/api/partner/v1",
  "integrator": "Ornek POS",
  "restaurant": { "merchantId": "…", "apiKey": "ck_test_…", "apiSecret": "…" },
  "store":      { "merchantId": "…", "apiKey": "ck_test_…", "apiSecret": "…" }
}

Hesap, bir test restoranı ve bir test Çarşı işletmesi için ayrı anahtar çifti içerir; IP izni tanımlanmaz. integrator alanındaki değer başvuruda yazdığınız firma adıdır ve X-Integrator başlığına yazılır.

Başvuru formundaki aydınlatma metni yürürlüğe girene kadar başvuru alınmaz. Formda şu satır yer alır: "Aydınlatma Metni'ni okudum ve anladım". Onay kutusu yoktur; başvuru bu satıra bağlı değildir.

İlk beş dakika

  1. GET /merchant ile işletmeyi okuyun; vertical değeri anahtarın restoran mı Çarşı mı olduğunu söyler.
  2. Restoran anahtarıyla GET /menu ile test menüsünü çekin (3 kategori, seçenek gruplu ürünler). Çarşı anahtarıyla GET /products ile test ürünlerini okuyun; test işletmesinde tartılı ürün de vardır.
  3. Webhook adresinizi kaydedin (Webhook) ve POST /orders/test ile sipariş üretin; order.created gerçek imzayla adresinize iletilir.
  4. Durumu ilerletin: POST /orders/{id}/status (Sipariş Yaşam Döngüsü). Test siparişleri kabul süresi dolduğunda otomatik iptal edilmez; iptal akışını cancel eylemiyle deneyin.
  5. Çarşı anahtarıyla toplama akışını deneyin (Toplama ve Dönüş).

Canlıdan farkları

AlanTipAçıklama
Kod ve sürümaynıAynı yayım; /api/health içinde gitSha ile doğrulanır.
Hız sınırı ve tavanlaraynıBkz. Servis Limitleri. Test ortamında gevşetilmez.
WebhookaçıkSizin adresinize gerçek çağrı yapılır; https ve kamuya açık adres şartı aynen geçerli.
Zamanlanmış işleraçıkTalep penceresi, toplu katalog kuyruğu ve fatura bağlantı denetimi canlı tempoda koşar.
Müşteri, kurye, bildirimyokGerçek müşteri ve kurye yoktur; SMS, e-posta ve mobil bildirim gönderilmez.
ParayokTest siparişleri kapıda ödeme olarak doğar; hakediş, komisyon ve defter oluşmaz.
Fiş görselialınmazToplamada receiptUrl doğrulanır ama depoya alınmaz; yanıtta receipt_not_saved uyarısı gelir.
Veri ömrü14 günSiparişler ve talepler 14 günden sonra silinir. Hesaplar, anahtarlar ve katalog değişiklikleri kalır.

Canlıya geçiş

Canlı anahtar işletme tarafından partner panelinden üretilir (Hemen Başla). Geçişte yalnız taban adresi ve anahtarı değiştirin; başlıklar ve gövdeler aynıdır. Canlıda ilk doğrulama için yine POST /orders/test kullanılabilir; bu sipariş de ciroya girmez.

Taban adresi ve anahtarı yapılandırmadan okuyun, koda yazmayın. Test ve canlı yapılandırmasını birlikte tutan bir kasa yazılımı, ortamı işletme başına seçebilir.
ÖncekiHemen BaşlaSonrakiYetkilendirme
Bu sayfada
  • Taban adres ve anahtarlar
  • Test hesabı başvurusu
  • İlk beş dakika
  • Canlıdan farkları
  • Canlıya geçiş