Ana içeriğe atla
Headless API’nin tamamı bir OpenAPI 3 tanımıyla belgelenmiştir. Bu tanım API ile birlikte güncel kalır: sitenizin sürümü neyi destekliyorsa belge de onu anlatır.

Erişim adresleri

Aşağıdaki adreslerin hepsi herkese açıktır (anahtar ve lisans gerektirmez) ve sitenizin adresine göre çalışır: Yönetim panelinde Ayarlar → Headless API → Geliştirici Kaynakları bölümünden de bu bağlantılara ulaşabilirsiniz.
Bu adresleri kullanabilmek için Headless API’nin panelden açık olması gerekir.

İnteraktif dokümanı kullanma

/headless/docs adresini açın:
1

Endpoint'e göz atın

Sol menüde gruplar (Site, Auth, Store, Cart, Forum…) listelenir. Aramayla endpoint bulabilirsiniz.
2

Ayrıntıları okuyun

Her endpoint için parametreler, istek gövdesi, başarılı yanıt şemaları, olası hata kodları, captcha gereksinimi ve hangi kimlik doğrulamasının gerektiği görünür.
3

Deneyin

Test Request ile doğrudan istek gönderin. Kimlik doğrulama bölümüne pk_live_... anahtarınızı (publicKey) ve gerekiyorsa giriş yanıtındaki token’ı (bearerAuth) girin.
4

Kod örneği alın

Sağ panelde cURL, JavaScript, PHP, Python gibi dillerde hazır istek örnekleri bulunur.
Tarayıcıdan test ederken CORS hatası alırsanız doküman adresinin origin’ini (https://siteniz.com zaten izinlidir) kullanın veya geliştirme sırasında geçici olarak ilgili origin’i ekleyin.

Tanımın yapısı

  • Sunucu: {siteUrl}/headless/v1 (değişken olarak sitenizin adresi).
  • Güvenlik şemaları:
    • publicKey: X-LeaderOS-Key başlığı
    • bearerAuth: Authorization: Bearer <token>
  • Etiketler (gruplar): Site, Auth, Account, Store, Cart, Payments, Credits, Chest, Forum, Support, Blog, Help ve diğerleri.
  • Her operasyonda benzersiz operationId (ör. listBlogPosts), x-error-codes (olası hata kodları) ve gerekiyorsa x-captcha (hangi captcha sayfası) bulunur.

OpenAPI ile neler yapabilirsiniz?

Tip üretme (TypeScript)

Resmi SDK zaten tipleri içerir; kendi istemcinizi yazıyorsanız kullanın.

İstemci üretme (diğer diller)

OpenAPI Generator ile PHP, Python, Kotlin, Swift, C# vb. için istemci üretin:

Postman / Insomnia / Bruno

openapi.json adresini Import ederek tüm endpoint’leri koleksiyon olarak alın. Koleksiyon değişkenlerine siteUrl ve anahtarı girin.

Yapay zeka

URL’yi asistana verin ya da MCP sunucusu aracılığıyla otomatik okutun (bkz. MCP).

Postman ile içe aktarma

  1. Import → Link seçin ve https://siteniz.com/headless/openapi.json yazın.
  2. Koleksiyon Variables bölümünde siteUrl = https://siteniz.com tanımlayın.
  3. Koleksiyonun Authorization sekmesinde API Key seçin: key X-LeaderOS-Key, value pk_live_..., add to Header.
  4. Giriş gerektiren istekler için POST /auth/login yanıtındaki token’ı Bearer Token olarak ekleyin.

Dil ve içerik başlıkları

Test ederken şu başlıkları da kullanabilirsiniz: Dosya yükleyen uçlar (avatar, destek eki vb.) multipart/form-data kabul eder.

Sürüm ve değişiklikler

OpenAPI info.version API sürümünü gösterir. Sitenizi LeaderOS güncellemesiyle yükselttiğinizde openapi.json otomatik güncellenir; istemci tiplerinizi yeniden üretmeniz yeterlidir (resmi SDK’da npm update @leaderos/headless-sdk).