API Referansı

Paketler

Restoranlara atanan kullanım paketleri ve hesap bakiyeleri.

Taban URL

taban url

https://api.v1.fastsiparis.com

POST/web-api/v1/restaurants/{restaurantId}/assign-package

Restorana Paket Ata

Restorana kullanım paketi tanımlar. Entegrasyon eklemeden önce gereklidir.

Parametreler

Ad	Konum	Tip	Zorunlu	Seçenekler
restaurantId	path	string	Evet	—

Gövde Alanları

Ad	Tip	Zorunlu
userPackageId	string	Evet
businessName	string	Hayır

Header'lar

Ad	Değer
Authorization	Bearer POSENTEGRA_API_KEY
Content-Type	application/json

İstek Gövdesi

JSON

json

{
  "userPackageId": "{userPackageId}",
  "businessName": "PosEntegra"
}

Kod Örneği

bash

curl --request POST \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/restaurants/{restaurantId}/assign-package' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{  "userPackageId": "{userPackageId}",  "businessName": "PosEntegra"}'

Yanıtlar

201Created

JSON

json

{
  "success": true
}

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

Restoran Paketlerini Listele

Restorana atanmış paketleri ve kalan bakiyelerini döndürür.

Parametreler

Ad	Konum	Tip	Zorunlu	Seçenekler
restaurantId	path	string	Evet	—

Header'lar

Ad	Değer
Authorization	Bearer POSENTEGRA_API_KEY

Kod Örneği

bash

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

Yanıtlar

200OK

JSON

json

{
  "success": true,
  "data": [
    {
      "id": "rp_1",
      "restaurantId": "{restaurantId}",
      "packageId": "pkg_1"
    }
  ]
}

GET/web-api/v1/user/packages

Kullanıcı Paket Bakiyelerini Listele

Hesabınızdaki paketlerin kalan kullanım adetlerini döndürür.

Header'lar

Ad	Değer
Authorization	Bearer POSENTEGRA_API_KEY

Kod Örneği

bash

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

Yanıtlar

200OK

JSON

json

{
  "success": true,
  "data": [
    {
      "id": "up_1",
      "packageId": "pkg_1",
      "quantity": 10
    }
  ]
}

GET/web-api/v1/user/packages/available

Satın Alınabilir Paketleri Listele

Satın alınabilecek paket tiplerini ve fiyatlarını listeler.

Header'lar

Ad	Değer
Authorization	Bearer POSENTEGRA_API_KEY

Kod Örneği

bash

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

Yanıtlar

200OK

JSON

json

{
  "success": true,
  "data": [
    {
      "id": "up_1",
      "name": "Starter"
    }
  ]
}

Siparişler

Entegrasyonlar