WISECP API'si

14 görüntülenme Markdown

API nedir, hangi adres hangi çağırana cevap verir ve bir kuruluma yapabileceğiniz ilk çağrı nedir.

Genel Bakış

API aynı kuruluma ikinci bir kapı açar. Sunduğu her şey panelin zaten yaptığı işi kapsar: müşteri oluşturmak, fatura kesmek, hizmet kurmak, talep okumak. Fark şurada: isteği kim yapıyor. Panel ekran başındaki insan için, API sizin kodunuz için.

HTTPS üzerinden JSON konuşur; gerçek HTTP metotları ve gerçek durum kodları kullanır. Bir çağrı oturum çerezi değil API anahtarı taşır, yani kimsenin giriş yapmış olmasına bağlı değil.

Bu bir veritabanı aynası değil. Her kaynak, kuralları üzerinde olan bir iş eylemi. Çağrı panelin geçtiği kapılardan geçer: izinler, doğrulama, kancalar, etkinlik kayıtları.

Ön Koşullar

Entegre olmaya yetkili olduğunuz bir kurulumun adresi.
Bir API anahtarı. Hangi türü gerektiği ihtiyacınız olan adrese bağlı; sonraki makale ikisini de anlatır.
İstek başlığı gönderebilen bir istemci. Bu API'yi her şey çağırabilir; örnekler cURL, JavaScript ve PHP ile.

Yapı

/api/v1 altında üç adres var. Sürümden sonraki segment hangisinin cevap vereceğini belirler.

/api/v1/admin Operatörün erişimi: kurulumdaki her müşteri, sipariş, fatura, ürün ve ayar. Kendi iç aracınızı, bir aktarımı ya da kendi bayi panelinizi besler.

/api/v1/client Kendi hesabını yöneten tek bir müşteri. Her çağrı anahtarın ait olduğu hesapla sınırlı; bir anahtar komşusunu asla okuyamaz.

/api/v1/<yol> Bir modülün kendisi için açtığı yollar. Kurulum burada kendi yolunu sunmaz; cevap veren şey, kurulu modüllerin kaydettikleri.

Kimlik isteyen iki adres, üzerine süzgeç konmuş tek bir ürün değil, ayrı iki ürün. Biri için verilen anahtar diğerinde reddedilir; ikisini adres ayırır.

Örnek

Sağlık kontrolü anahtar istemez, dolayısıyla dürüst bir ilk çağrıdır: herhangi bir kimlik devreye girmeden adresin doğru ve API'nin erişilebilir olduğunu kanıtlar.

ilk çağrı

curl 'https://panel.example.com/api/v1/admin/ping'
# {"data":{"pong":true,"version":"v1","time":"2026-08-06 10:12:41"}}

# anahtarla: bu uç, anahtarın kim olduğunu ve neye izinli olduğunu söyler
curl -H 'Authorization: Bearer wak_...' \
     'https://panel.example.com/api/v1/admin/whoami'

Tuzaklar

Size hiçbir şey gönderilmez

Webhook teslimi yok. Bir şeyin ne zaman olduğunu bilmesi gereken entegrasyon ya belirli aralıklarla tekrar sorar ya da bir kanca aracılığıyla kendi kodunu kurulumun içinde çalıştırır. Olaylara Tepki Verme ikisini de anlatır.

v1 donduruldu, bu size verilen bir söz

Yeni uçlar, yeni yanıt alanları ve yeni isteğe bağlı girdiler v1'e gelmeye devam eder. Alan silmek, ad değiştirmek, tip değiştirmek ya da bir girdiyi zorunlu yapmak gelmez: o iş v2'yi bekler. Kaldırılacak bir uç, Deprecation başlığıyla ve en az altı aylık geçiş süresiyle duyurulur.

Faydalı oldu mu?

Geri bildiriminiz için teşekkürler!

Hâlâ Yardıma mı İhtiyacınız Var?

Yukarıda bulamadığınız her şey için destek ekibimiz her zaman yanınızda.

Bize Ulaşın Destek Talebi Oluştur