API Referansı

İşletmeler

İşletme, hesabınızın en üst seviyedeki kaydıdır. Restoranlar bir işletmeye bağlanır.
Taban URL
https://api.v1.fastsiparis.com
GET/web-api/v1/businesses

Tüm İşletmeleri Getir

Hesabınıza bağlı tüm işletmeleri döndürür.

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY

Kod Örneği

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

Yanıtlar

POST/web-api/v1/businesses

İşletme Oluştur

Yeni bir işletme kaydı açar. Zorunlu tek alan `name`; adres, vergi dairesi, vergi numarası ve iletişim bilgileri isteğe bağlıdır.

Gövde Alanları

AdTipZorunlu
namestringEvet
descriptionstringHayır
vatNumberstringHayır
taxOfficestringHayır
addressstringHayır
citystringHayır
countrystringHayır
zipCodestringHayır
phonestringHayır
emailstringHayır

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY
Content-Typeapplication/json

İstek Gövdesi

JSON
{
  "name": "posentegra",
  "email": "info@posentegra.com",
  "phone": "05555555555",
  "address": "Teknokent",
  "city": "Ankara",
  "country": "Türkiye",
  "taxOffice": "Ankara",
  "vatNumber": "1234567890",
  "zipCode": "06000",
  "description": "Ana Merkez"
}

Kod Örneği

curl --request POST \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/businesses' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{  "name": "posentegra",  "email": "info@posentegra.com",  "phone": "05555555555",  "address": "Teknokent",  "city": "Ankara",  "country": "Türkiye",  "taxOffice": "Ankara",  "vatNumber": "1234567890",  "zipCode": "06000",  "description": "Ana Merkez"}'

Yanıtlar

GET/web-api/v1/businesses/{businessId}

İşletme Detayını Getir

Tek bir işletmenin tüm alanlarını döndürür.

Parametreler

AdKonumTipZorunluSeçenekler
businessIdpathstringEvet

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY

Kod Örneği

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

Yanıtlar

PUT/web-api/v1/businesses/{businessId}

İşletme Güncelle

İşletmenin ad, açıklama gibi alanlarını günceller.

Parametreler

AdKonumTipZorunluSeçenekler
businessIdpathstringEvet

Gövde Alanları

AdTipZorunlu
namestringEvet
descriptionstringHayır
vatNumberstringHayır
taxOfficestringHayır
addressstringHayır
citystringHayır
countrystringHayır
zipCodestringHayır
phonestringHayır
emailstringHayır

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY
Content-Typeapplication/json

İstek Gövdesi

JSON
{
  "name": "posentegra",
  "description": "Güncellenmiş açıklama"
}

Kod Örneği

curl --request PUT \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/businesses/{businessId}' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{  "name": "posentegra",  "description": "Güncellenmiş açıklama"}'

Yanıtlar

DELETE/web-api/v1/businesses/{businessId}

İşletme Sil

İşletmeyi ve bağlı kayıtları siler. Geri alınamaz.

Parametreler

AdKonumTipZorunluSeçenekler
businessIdpathstringEvet

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY

Kod Örneği

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

Yanıtlar

GET/web-api/v1/businesses/{businessId}/restaurantskoleksiyon

İşletme Restoranlarını Getir

Belirtilen işletmeye bağlı restoranları listeler.

Parametreler

AdKonumTipZorunluSeçenekler
businessIdpathstringEvet

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY

Kod Örneği

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

Yanıtlar

200OK
JSON
{
  "success": true,
  "data": [
    {
      "id": "r_123",
      "name": "Serdivan Şubesi"
    }
  ]
}