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

Hesap

Bağlantıyı doğrula

GET/v1/me

Anahtarın çalıştığını, kapsamlarını, erişebildiği markaları ve bu ortamın API adresini görün; ilk istekte ve yetki sorunlarını çözerken kullanın.

Gereken izin

Geçerli Bearer anahtarı; ek kapsam gerekmez.

Maliyet

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

Tekrar anahtarı

Gerekmez (okuma).

İstek

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

Örnek istek

curl --fail-with-body --silent --show-error --request GET \
  "${SIPARIS_API_URL:-https://api.siparis.app/v1}/me" \
  -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 + "/me", 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 + "/me", {
  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

{
  "api_url": "https://api.siparis.app/v1",
  "api_version": "v1",
  "environment": "live",
  "id": "grt_1234567890abcdef1234567890abcdef",
  "scopes": [
    "orders:read",
    "events:read"
  ],
  "stores": [
    {
      "id": "sto_1234567890abcdef1234567890abcdef",
      "name": "Örnek Marka"
    }
  ]
}
Yanıt alanları (13)
AlanTürZorunluAçıklamaÖrnek
api_urlmetinEvetBu ortamın /v1 içeren temel adresi."https://api.siparis.app/v1"
api_versionmetinEvetAPI ana sürümü."v1"
environmentmetinEvetBağlantının ortamı: live veya test."live"
idmetinEvetKaynağın dış kimliği; grt_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."grt_1234567890abcdef1234567890abcdef"
scopesliste: metinEvetBu API bağlantısına açık kapsamlar; yazma kapsamı okuma vermez.
storesliste: nesneEvetAnahtarın okuyabildiği etkin markalar.
idmetinEvetKaynağın dış kimliği; sto_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."sto_1234567890abcdef1234567890abcdef"
namemetinEvetErişilebilen markanın adı."Örnek Marka"
actor_typemetinHayırAPI anahtarı için api, OAuth kurulumu için app."app"
applicationnesne · null olabilirHayırOAuth uygulaması ve kurulumu; API anahtarında boş.null
idmetinEvetUygulamanın app_ önekli kimliği."app_1234567890abcdef1234567890abcdef"
installation_idmetinEvetBu işletmedeki kurulumun ins_ önekli kimliği."ins_1234567890abcdef1234567890abcdef"
namemetinEvetUygulama adı."Örnek uygulama"

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.