Referans

OpenAPI sözleşmesini indir

GET/v1/openapi.json

Bütün uçları, alanları ve örnekleri içeren OpenAPI 3.1 belgesini indirin; istemci üretimi, alan doğrulama ve AI entegrasyonu için kullanın.

Gereken izin: Yok; herkese açık, anahtar gerekmez.
Maliyet: 0 puan (bağlantı başına 60 saniyede 600 puan)
Tekrar anahtarı: Gerekmez (okuma).

İstek

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

Örnek istek

cURLPythonTypeScript

curl --fail-with-body --silent --show-error --request GET \
  "${SIPARIS_API_URL:-https://api.siparis.app/v1}/openapi.json"

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 = {

}
request = Request(base + "/openapi.json", 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";
const response = await fetch(base + "/openapi.json", {
  method: "GET",
  headers: {

  },
  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

{
  "info": {
    "title": "siparis.app Açık API",
    "version": "v1"
  },
  "openapi": "3.1.0",
  "paths": {}
}

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.