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

Olaylar ve Webhook

Webhook adresini kapat

POST/v1/webhook_endpoints/{id}/close

Entegrasyonu durdururken adresi kapatın; teslim geçmişi kalır.

Gereken izin

Bearer anahtarı ve webhooks:manage

Maliyet

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

Tekrar anahtarı

Gerekir: Idempotency-Key başlığı.

İstek

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

Yol parametreleri

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

Başlıklar

AlanTürZorunluAçıklamaÖrnek
Idempotency-Keymetin · null olabilirEvetZorunlu tekrar anahtarı; en çok 200 karakter. Yeni işte yeni değer; ağ tekrarında aynı gövde ve aynı değer."ilk-esitleme-20261016-001"

Örnek istek

curl --fail-with-body --silent --show-error --request POST \
  "${SIPARIS_API_URL:-https://api.siparis.app/v1}/webhook_endpoints/whe_1234567890abcdef1234567890abcdef/close" \
  -H "Authorization: Bearer $SIPARIS_API_KEY" \
  -H 'Idempotency-Key: ornek-post-v1-webhook-endpoints-whe-1234567890abcdef1234567890abcdef-close-001'
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"],
    "Idempotency-Key": "ornek-post-v1-webhook-endpoints-whe-1234567890abcdef1234567890abcdef-close-001",
}
request = Request(base + "/webhook_endpoints/whe_1234567890abcdef1234567890abcdef/close", headers=headers, method="POST")
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 + "/webhook_endpoints/whe_1234567890abcdef1234567890abcdef/close", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.SIPARIS_API_KEY}`,
    "Idempotency-Key": "ornek-post-v1-webhook-endpoints-whe-1234567890abcdef1234567890abcdef-close-001",
  },
  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

{
  "endpoint": {
    "created_at": "2026-10-16T09:00:00Z",
    "event_types": [
      "order.created"
    ],
    "grant": "grt_1234567890abcdef1234567890abcdef",
    "id": "whe_1234567890abcdef1234567890abcdef",
    "last_attempt_at": null,
    "last_error": null,
    "last_success_at": null,
    "previous_secret_until": null,
    "schema_version": 1,
    "status": "pending_test",
    "store": "sto_1234567890abcdef1234567890abcdef",
    "store_name": "Örnek Marka",
    "url": "https://example.com/webhooks/siparis"
  }
}
Yanıt alanları (15)
AlanTürZorunluAçıklamaÖrnek
endpointnesneEvetWebhook adresinin güncel durumu.
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
event_typesliste: metinEvetDinlenecek olay türleri; jokerler oluşturma anındaki izinli türlere sabitlenir.
grantmetinEvetAPI bağlantısı kimliği (grt_ ve 32 küçük onaltılık karakter)."grt_1234567890abcdef1234567890abcdef"
idmetinEvetKaynağın dış kimliği; whe_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."whe_1234567890abcdef1234567890abcdef"
last_attempt_attarih-saat · null olabilirEvetSon teslim denemesi zamanı; RFC 3339 UTC. Değer yoksa null.null
last_errormetin · null olabilirEvetSon teslim hatasının kararlı kodu; hata yoksa null.null
last_success_attarih-saat · null olabilirEvetSon başarılı teslim zamanı; RFC 3339 UTC. Değer yoksa null.null
previous_secret_untiltarih-saat · null olabilirEvetÖnceki webhook sırrının geçerlilik sonu zamanı; RFC 3339 UTC. Değer yoksa null.null
schema_versiontam sayıEvetOlay yükünün şema sürümü.1
statusmetin (seçenekler: pending_test, active, disabled_auto, disabled_remote, closed)Evetpending_test: deneme bekliyor; active: açık; disabled_auto: hatalarla durdu; disabled_remote: alıcı 410 verdi; closed: kapalı."pending_test"
storemetin · null olabilirEvetMarka kimliği (sto_ ve 32 küçük onaltılık karakter)."sto_1234567890abcdef1234567890abcdef"
store_namemetin · null olabilirEvetWebhook adresinin bağlı olduğu markanın görünen adı."Örnek Marka"
urlmetinEvetGenel internete açık, kullanıcı bilgisi içermeyen HTTPS webhook adresi; port 443."https://example.com/webhooks/siparis"
secretmetin · null olabilirHayırYalnız oluşturma/döndürmenin ilk yanıtında bir kez gösterilen whsec_ imza sırrı; Idempotent-Replayed yanıtında alan yoktur. Güvenli ortam değişkeninde saklayın."whsec_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="

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.