T-SOFT/Admin API/Sürümler

Sürümler

Admin API tarihli sürümlerle yayınlanır. Uygulamanız bir sürüme bağlanır; o sürümün davranışı destek süresi boyunca sessizce değişmez ve kaldırılacak her şey önceden yanıt başlıklarıyla duyurulur.

Sürüm adreste

Sürüm, isteğin adresindedir. Başlıkla ya da sorgu parametresiyle seçilmez; varsayılan sürüm yoktur.

https://<mağaza-alan-adı>/api/v3/admin/2026-01/catalog/products

Her yanıt, hata yanıtları dahil, isteğin işlendiği sürümü bildirir:

X-TSoft-Api-Version: 2026-01

Takvim ve destek süresi

  • Sürümler çeyreklik çıkar ve adını yayın ayından alır: 2027-01, 2027-04, 2027-07, 2027-10. Bir çeyrekte geriye uyumsuz değişiklik yoksa o çeyrek atlanabilir.
  • Her sürüm, kendinden sonraki sürüm yayınlandıktan en az 12 ay desteklenir. Bu süre boyunca iki sürüm yan yana çalışır; geçişi bu pencerede yaparsınız.
  • Bir sürümün içinde yeni kaynak, yeni alan, yeni filtre ve yeni ilişki eklenebilir. Var olan alan kaldırılmaz, adı ya da tipi değişmez; var olan uç kaldırılmaz. Bu tür değişiklikler yalnız yeni sürümde yapılır.
SürümDurumYayınDestek sonu
2026-01GüncelOcak 20262027-01 yayınlandıktan en az 12 ay sonra; en erken Ocak 2028
2027-01PlanlananOcak 2027—

Uygulamanız yeni alanların gelmesine hazır olmalı: tanımadığınız attributes anahtarlarını yok sayın.

Kullanımdan kaldırma başlıkları

Bir sürüm, uç ya da alan kullanımdan kalkacaksa, o istekle ilgili her yanıta şu başlıklar eklenir:

BaşlıkAnlamıÖrnek
DeprecationKullanımdan kaldırma tarihi, Unix zaman damgası (RFC 9745)@1798750800
SunsetBu tarihten sonra istek çalışmaz (RFC 8594)Fri, 31 Dec 2027 21:00:00 GMT
LinkGeçiş belgesi; rel="deprecation" ve rel="sunset"<https://developer.tsoft.com.tr/api/surumler>; rel="deprecation"; type="text/html"
X-TSoft-Api-Deprecated-ReasonKısa gerekçe ve yerine ne kullanılacağı (ASCII)legacyStatus yerine status kullanin.
  • Sürüm kalkıyorsa başlıklar o sürümdeki bütün yanıtlarda bulunur.
  • Uç kalkıyorsa yalnız o uca yapılan isteklerde bulunur.
  • Alan kalkıyorsa o alanı taşıyan kaynak tipini döndüren her uçta bulunur. Alan, Sunset tarihine kadar yanıtta dolu gelmeye devam eder.
  • Birden fazla bildirim aynı yanıta düşerse Deprecation ve Sunset en erken tarihi gösterir.

İstemcinizde bu başlıkları kaydedin ve izleyin. Sunset tarihi, değişikliğin değişiklik günlüğündeki kaydıyla aynıdır.

deprecation-log.ts
const res = await fetch(url, { headers })

if (res.headers.has("Deprecation") || res.headers.has("Sunset")) {
  logger.warn("T-SOFT Admin API deprecation", {
    url,
    version: res.headers.get("X-TSoft-Api-Version"),
    sunset: res.headers.get("Sunset"),
    reason: res.headers.get("X-TSoft-Api-Deprecated-Reason"),
    link: res.headers.get("Link"),
  })
}

Desteklenmeyen sürüm

İstek başka bir sürüme sessizce yönlendirilmez. Var olmayan bir sürüm (2025-10 gibi) ya da henüz yayınlanmamış bir sürüm 404 döner:

{
  "jsonapi": { "version": "1.0" },
  "errors": [
    {
      "status": "404",
      "code": "api_version_unsupported",
      "title": "Unsupported API version",
      "detail": "API version 2025-10 does not exist. Use one of: 2026-01.",
      "links": { "about": "https://developer.tsoft.com.tr/api/surumler" },
      "meta": {
        "requestedVersion": "2025-10",
        "supportedVersions": ["2026-01"],
        "latestVersion": "2026-01"
      }
    }
  ]
}

Destek süresi biten sürüm 410 Gone döner; code değeri api_version_retired, meta.retiredAt desteğin bittiği gündür. Bu iki hatayı yeniden denemeyin; adresteki sürümü güncelleyin.

Değişiklik günlüğü

Geliştiriciyi etkileyen her değişiklik (yeni uç ve alanlar, kullanımdan kalkanlar, yeni sürümler, kapsam ve webhook değişiklikleri) yayınlandığı gün geliştirici değişiklik günlüğüne düşer:

Mağaza sahiplerine yönelik ürün yenilikleri ayrı akıştadır: changelog.tsoft.com.tr.