İçeriğe geç
siparis.app geliştiriciAnahtarları yönet ↗

Ürünler

Kategoriyi getir

GET/v1/categories/{id}

Bir kategorinin adını, açıklamasını ve görünür üst kategorisini okuyun.

Gereken izin

Bearer anahtarı ve products:read

Maliyet

1 puan (bağlantı başına 60 saniyede 600 puan)

Tekrar anahtarı

Gerekmez (okuma).

İstek

Temel adres: https://api.siparis.app/v1

Yol parametreleri

AlanTürZorunluAçıklamaÖrnek
idmetinEvetOkunacak kaynağın cat_ önekli dış kimliği."cat_1234567890abcdef1234567890abcdef"

Sorgu parametreleri

AlanTürZorunluAçıklamaÖrnek
archivedtrue/falseHayırtrue arşivdeki ve kapalı kayıtları da içerir; varsayılan false.false

Örnek istek

curl --fail-with-body --silent --show-error --request GET \
  "${SIPARIS_API_URL:-https://api.siparis.app/v1}/categories/cat_1234567890abcdef1234567890abcdef" \
  -H "Authorization: Bearer $SIPARIS_API_KEY"
import json
import os
from urllib.request import Request, build_opener, HTTPRedirectHandler
from urllib.error import HTTPError

# İmzalı indirme hedefine Bearer taşımamak için yönlendirme kendiliğinden izlenmez.
class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None

base = os.environ.get("SIPARIS_API_URL", "https://api.siparis.app/v1")
headers = {
    "Authorization": "Bearer " + os.environ["SIPARIS_API_KEY"],
}
request = Request(base + "/categories/cat_1234567890abcdef1234567890abcdef", headers=headers, method="GET")
try:
    with build_opener(NoRedirect).open(request, timeout=30) as response:
        print(response.read().decode("utf-8"))
except HTTPError as error:
    print(error.code, error.read().decode("utf-8"))
    raise
// Node.js 22+; anahtar yalnız sunucunun ortam değişkenindedir.
const base = process.env.SIPARIS_API_URL ?? "https://api.siparis.app/v1";
if (!process.env.SIPARIS_API_KEY) throw new Error("SIPARIS_API_KEY gerekli");
const response = await fetch(base + "/categories/cat_1234567890abcdef1234567890abcdef", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.SIPARIS_API_KEY}`,
  },
  redirect: "manual", // 307 hedefini Bearer olmadan ayrı istekte okuyun.
  signal: AbortSignal.timeout(30_000),
});
const text = await response.text();
if (!response.ok) throw new Error(`${response.status}: ${text}`);
console.log(text);

Kimlik içeren yollarda örnek kimliği kendi liste yanıtınızdan alın. SIPARIS_API_KEY sunucu ortamında tanımlı olmalı; yerelde SIPARIS_API_URL ile /v1 içeren adresi değiştirin. Üretimde tekrar kurallarını uygulayın.

Yanıt

200 İstek başarıyla tamamlandı.

İçerik türü: application/json

{
  "archived": false,
  "created_at": "2026-10-16T09:00:00Z",
  "description": "Seramik kupa, 300 ml.",
  "id": "cat_1234567890abcdef1234567890abcdef",
  "image": "https://example.com/kupa.jpg",
  "name": "Mutfak",
  "parent": null,
  "revision": 1,
  "slug": "ornek-kupa",
  "sort_order": 0,
  "status": "active",
  "updated_at": "2026-10-16T09:00:00Z"
}
Yanıt alanları (12)
AlanTürZorunluAçıklamaÖrnek
archivedtrue/falseEvetArşivdeki veya kapanmış kaynaksa true. archived=true süzgeci bunları da içerir.false
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
descriptionmetin · null olabilirEvetKaynağın açıklama metni."Seramik kupa, 300 ml."
idmetinEvetKaynağın dış kimliği; cat_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."cat_1234567890abcdef1234567890abcdef"
imagemetin · null olabilirEvetGörselin genel HTTPS adresi."https://example.com/kupa.jpg"
namemetinEvetKaydın görünen adı."Mutfak"
parentmetin · null olabilirEvetÜst kategori kimliği (cat_ ve 32 küçük onaltılık karakter).null
revisiontam sayıEvetKaydın revizyonu; If-Match için ETag ile birlikte kullanılır.1
slugmetin · null olabilirEvetAdreslerde kullanılan kısa ad."ornek-kupa"
sort_ordertam sayıEvetPanel ve vitrindeki sırası; küçük değer önce gelir.0
statusmetinEvetKaynağın işlem durumu."active"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"

Bu uca özgü yanıt başlıkları: ETag (Kaynağın güçlü sürüm etiketi; If-Match için tırnaklarıyla saklayın.).

Hatalar

Bu uca özgü hata yok.

Ortak hatalar (anahtar, izin, istek biçimi, hız sınırı, tekrar anahtarı) her uçta aynıdır: Hata kodları › Ortak hatalar.