API Referansı
Restoranlar
Sipariş alan fiziksel şubeler. Entegrasyonlar ve paketler restoran seviyesinde tanımlanır.
Taban URL
taban url
https://api.v1.fastsiparis.comPOST
/web-api/v1/businesses/{businessId}/restaurantsMevcut Restoranı İşletmeye Bağla
Var olan bir restoranı işletmeye bağlar.
Parametreler
| Ad | Konum | Tip | Zorunlu | Seçenekler |
|---|---|---|---|---|
| businessId | path | string | Evet | — |
Gövde Alanları
| Ad | Tip | Zorunlu |
|---|---|---|
| restaurantId | string | Evet |
Header'lar
| Ad | Değer |
|---|---|
| Authorization | Bearer POSENTEGRA_API_KEY |
| Content-Type | application/json |
İstek Gövdesi
JSON
json
{
"restaurantId": "{restaurantId}"
}Kod Örneği
bash
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/restaurantsTüm Restoranları Getir
Hesabınıza bağlı tüm restoranları 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/restaurants' \
--header 'Authorization: Bearer POSENTEGRA_API_KEY'Yanıtlar
POST
/web-api/v1/restaurantsRestoran Oluştur
Bir işletmenin altına yeni restoran ekler.
Gövde Alanları
| Ad | Tip | Zorunlu |
|---|---|---|
| businessId | string | Hayır |
| name | string | Evet |
| description | string | Hayır |
| address | string | Hayır |
| lat | number | Hayır |
| lon | number | Hayır |
| config | object | Hayır |
| paymentMatchingUrl | string | Hayır |
| paymentMatchingHeaders | object | Hayır |
Header'lar
| Ad | Değer |
|---|---|
| Authorization | Bearer POSENTEGRA_API_KEY |
| Content-Type | application/json |
İstek Gövdesi
JSON
json
{
"businessId": "{businessId}",
"name": "Serdivan Şubesi",
"description": "Serdivan AVM yanı"
}Kod Örneği
bash
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
| 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}' \
--header 'Authorization: Bearer POSENTEGRA_API_KEY'Yanıtlar
200OK
JSON
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
| Ad | Konum | Tip | Zorunlu | Seçenekler |
|---|---|---|---|---|
| restaurantId | path | string | Evet | — |
Gövde Alanları
| Ad | Tip | Zorunlu |
|---|---|---|
| businessId | string | Hayır |
| name | string | Evet |
| description | string | Hayır |
| address | string | Hayır |
| lat | number | Hayır |
| lon | number | Hayır |
| config | object | Hayır |
| paymentMatchingUrl | string | Hayır |
| paymentMatchingHeaders | object | Hayır |
Header'lar
| Ad | Değer |
|---|---|
| Authorization | Bearer POSENTEGRA_API_KEY |
| Content-Type | application/json |
İstek Gövdesi
JSON
json
{
"name": "Serdivan Şubesi (Yenilendi)",
"description": "Yeni konsept"
}Kod Örneği
bash
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
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
| 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 DELETE \
--url 'https://api.v1.fastsiparis.com/web-api/v1/restaurants/{restaurantId}' \
--header 'Authorization: Bearer POSENTEGRA_API_KEY'Yanıtlar
200OK
JSON
json
{
"success": true
}GET
/web-api/v1/providers/migros/menuskoleksiyonRestoran Entegrasyona Özel Menüleri Çağır
Seçili platformdaki menüyü restoran bazında getirir.
Parametreler
| Ad | Konum | Tip | Zorunlu | Seçenekler |
|---|---|---|---|---|
| restaurantId | query | 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/providers/migros/menus?restaurantId={restaurantId}' \
--header 'Authorization: Bearer POSENTEGRA_API_KEY'Yanıtlar
200OK
JSON
json
{
"success": true
}