Menuz API · REST · JSON

Menünüzü kendi sitenizde ve uygulamanızda kullanın

Tek bir istekle restoranınızın menüsünü, kategorilerini ve ürünlerini JSON olarak alırsınız. Anahtarınızı Menuz panelinde Özel Ayarlar > API erişimi sayfasından oluşturursunuz.

Genel bakış

Menuz API, menünüzü kendi web sitenizde, mobil uygulamanızda, kiosk ya da dijital ekranlarınızda göstermeniz için menü verisini JSON olarak verir. Panelde yaptığınız her değişiklik (fiyat, ürün, tükendi durumu) bir sonraki istekte yansır.

  • Adreshttps://menuz.com.tr/api/public-menu.php
  • Biçimapplication/json; charset=utf-8
  • ErişimSalt okunur (GET)
  • PlanZincir ve Resort planlarında

Kimlik doğrulama

Her istekte API anahtarınızı X-API-Key başlığıyla gönderin. Anahtar hesabınıza bağlıdır; yalnızca kendi restoranlarınızın verisine erişir.

HTTP
X-API-Key: YOUR_API_KEY

Başlık ekleyemediğiniz ortamlarda anahtarı api_key sorgu parametresiyle de gönderebilirsiniz. Adresler sunucu kayıtlarında görünebildiği için başlık kullanmanızı öneririz.

URL
https://menuz.com.tr/api/public-menu.php?restaurant=lale-kahve&api_key=YOUR_API_KEY

Uç nokta

GET/api/public-menu.php

Bir restoranın profilini, aktif menülerini, kategorilerini ve ürünlerini tek yanıtta döndürür.

ParametreKonumZorunluAçıklama
restaurantqueryEvetRestoranın menü adresindeki kısa adı. Örnek: menuz.com.tr/m/lale-kahve
X-API-KeyheaderEvetAPI anahtarınız.
api_keyqueryHayırBaşlık yerine kullanılabilir.

Yanıt yapısı

Başarılı yanıt ok: true ile başlar. Fiyatlar ondalık metin olarak gelir ("85.00"); para birimi restaurant.currency alanındadır. is_available ve is_featured 1 ya da 0 değerini alır.

restaurant
id, name, slug, icon, description, address, phone, currency, currency_symbol, menu_theme, cover_url, theme_color

Restoranın profil bilgileri.

menus[]
id, name, categories[]

Yalnızca aktif menüler, oluşturulma sırasıyla.

categories[]
id, menu_id, name, icon, sort_order, items[]

Paneldeki sırasıyla (sort_order).

items[]
id, category_id, name, description, price, image_url, icon, is_available, is_featured, sort_order

Tükendi işaretli ürünler de gelir (is_available = 0).

Örnek yanıt (200)
{
  "ok": true,
  "restaurant": {
    "id": 1,
    "user_id": 2,
    "name": "Lale Kahve",
    "slug": "lale-kahve",
    "emoji": null,
    "icon": "coffee",
    "description": null,
    "address": null,
    "phone": null,
    "currency": "TRY",
    "currency_symbol": "₺",
    "menu_theme": "kahve",
    "cover_url": "/assets/uploads/covers/cover-1.webp",
    "theme_color": "#9a3412"
  },
  "menus": [
    {
      "id": 1,
      "name": "Ana Menü",
      "categories": [
        {
          "id": 2,
          "menu_id": 1,
          "name": "Sıcak Kahveler",
          "emoji": null,
          "icon": "coffee",
          "sort_order": 0,
          "items": [
            {
              "id": 5,
              "category_id": 2,
              "name": "Türk kahvesi",
              "description": "Bakır cezvede, yanında lokum ile.",
              "price": "85.00",
              "image_url": null,
              "emoji": null,
              "icon": "coffee",
              "is_available": 1,
              "is_featured": 1,
              "sort_order": 0
            }
          ]
        }
      ]
    }
  ]
}

Hata kodları

Hatalarda gövde her zaman aynı biçimdedir: {"ok": false, "error": "..."}

HTTPerrorNe yapmalı
200ok: trueİstek başarılı. Gövde menü verisini içerir.
401Missing API key.Anahtar gönderilmedi. X-API-Key başlığını ekleyin.
403Invalid API key.Anahtar yanlış ya da iptal edilmiş. Panelden yeni anahtar oluşturun.
422restaurant parameter is required.restaurant parametresi boş.
404Restaurant not found.Bu adrese sahip restoran yok, size ait değil ya da pasif.

İstek limiti ve önbellek

Şu an sabit bir istek limiti uygulanmıyor. Yanıtlar önbelleğe alınmaz (Cache-Control: no-store), her istek güncel veriyi döndürür. Sitenizde yanıtı 1 ile 5 dakika arasında kendi tarafınızda saklamanızı öneririz; menü değişikliklerinin görünmesi için bu süre yeterlidir.

Örnek istekler

Terminal
curl -s "https://menuz.com.tr/api/public-menu.php?restaurant=lale-kahve" \
  -H "X-API-Key: YOUR_API_KEY"
PHP 8
<?php
$ch = curl_init('https://menuz.com.tr/api/public-menu.php?restaurant=lale-kahve');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('MENUZ_API_KEY')],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$data = json_decode($body, true);
if ($status !== 200 || empty($data['ok'])) {
    throw new RuntimeException($data['error'] ?? 'Menuz API error');
}
foreach ($data['menus'] as $menu) {
    foreach ($menu['categories'] as $cat) {
        foreach ($cat['items'] as $item) {
            echo $item['name'], ': ', $item['price'], "\n";
        }
    }
}
Node.js
// Node.js 18+ (sunucu tarafı)
const res = await fetch('https://menuz.com.tr/api/public-menu.php?restaurant=lale-kahve', {
  headers: { 'X-API-Key': process.env.MENUZ_API_KEY },
});
const data = await res.json();
if (!res.ok || !data.ok) throw new Error(data.error);

for (const menu of data.menus) {
  for (const cat of menu.categories) {
    console.log(cat.name, cat.items.length);
  }
}

Güvenlik

  • Anahtarı yalnızca sunucu tarafında kullanın. Tarayıcıda çalışan koda ya da mobil uygulama paketine koymayın.
  • Anahtarı ortam değişkeninde (örneğin MENUZ_API_KEY) saklayın, kod deposuna eklemeyin.
  • Anahtarın sızdığını düşünüyorsanız panelden yenileyin. Eski anahtar o anda çalışmayı bırakır.