API Referansı

Restoranlar

Sipariş alan fiziksel şubeler. Entegrasyonlar ve paketler restoran seviyesinde tanımlanır.
Taban URL
https://api.v1.fastsiparis.com
POST/web-api/v1/businesses/{businessId}/restaurants

Mevcut Restoranı İşletmeye Bağla

Var olan bir restoranı işletmeye bağlar.

Parametreler

AdKonumTipZorunluSeçenekler
businessIdpathstringEvet

Gövde Alanları

AdTipZorunlu
restaurantIdstringEvet

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY
Content-Typeapplication/json

İstek Gövdesi

JSON
{
  "restaurantId": "{restaurantId}"
}

Kod Örneği

curl --request POST \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/businesses/{businessId}/restaurants' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{  "restaurantId": "{restaurantId}"}'

Yanıtlar

GET/web-api/v1/restaurants

Tüm Restoranları Getir

Hesabınıza bağlı tüm restoranları listeler.

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY

Kod Örneği

curl --request GET \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/restaurants' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY'

Yanıtlar

POST/web-api/v1/restaurants

Restoran Oluştur

Bir işletmenin altına yeni restoran ekler.

Gövde Alanları

AdTipZorunlu
businessIdstringHayır
namestringEvet
descriptionstringHayır
addressstringHayır
latnumberHayır
lonnumberHayır
configobjectHayır
paymentMatchingUrlstringHayır
paymentMatchingHeadersobjectHayır

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY
Content-Typeapplication/json

İstek Gövdesi

JSON
{
  "businessId": "{businessId}",
  "name": "Serdivan Şubesi",
  "description": "Serdivan AVM yanı"
}

Kod Örneği

curl --request POST \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/restaurants' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{  "businessId": "{businessId}",  "name": "Serdivan Şubesi",  "description": "Serdivan AVM yanı"}'

Yanıtlar

GET/web-api/v1/restaurants/{restaurantId}

Restoran Detayını Getir

Tek bir restoranın tüm alanlarını döndürür.

Parametreler

AdKonumTipZorunluSeçenekler
restaurantIdpathstringEvet

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY

Kod Örneği

curl --request GET \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/restaurants/{restaurantId}' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY'

Yanıtlar

200OK
JSON
{
  "success": true,
  "data": {
    "id": "{restaurantId}",
    "name": "Serdivan Şubesi"
  }
}
PUT/web-api/v1/restaurants/{restaurantId}

Restoran Güncelle

Restoranın ad, açıklama gibi alanlarını günceller.

Parametreler

AdKonumTipZorunluSeçenekler
restaurantIdpathstringEvet

Gövde Alanları

AdTipZorunlu
businessIdstringHayır
namestringEvet
descriptionstringHayır
addressstringHayır
latnumberHayır
lonnumberHayır
configobjectHayır
paymentMatchingUrlstringHayır
paymentMatchingHeadersobjectHayır

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY
Content-Typeapplication/json

İstek Gövdesi

JSON
{
  "name": "Serdivan Şubesi (Yenilendi)",
  "description": "Yeni konsept"
}

Kod Örneği

curl --request PUT \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/restaurants/{restaurantId}' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{  "name": "Serdivan Şubesi (Yenilendi)",  "description": "Yeni konsept"}'

Yanıtlar

200OK
JSON
{
  "success": true,
  "data": {
    "id": "{restaurantId}",
    "name": "Serdivan Şubesi (Yenilendi)"
  }
}
DELETE/web-api/v1/restaurants/{restaurantId}

Restoran Sil

Restoranı `restaurantId` parametresiyle siler. Geri alınamaz; başarılı istekte yalnızca `success: true` yanıtı döner.

Parametreler

AdKonumTipZorunluSeçenekler
restaurantIdpathstringEvet

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY

Kod Örneği

curl --request DELETE \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/restaurants/{restaurantId}' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY'

Yanıtlar

200OK
JSON
{
  "success": true
}
GET/web-api/v1/providers/migros/menuskoleksiyon

Restoran Entegrasyona Özel Menüleri Çağır

Seçili platformdaki menüyü restoran bazında getirir.

Parametreler

AdKonumTipZorunluSeçenekler
restaurantIdquerystringEvet

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY

Kod Örneği

curl --request GET \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/providers/migros/menus?restaurantId={restaurantId}' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY'

Yanıtlar

200OK
JSON
{
  "success": true
}