Müşteri API'sine Giriş

1.8k görüntülenme Markdown

Müşterinin kendi hesabında kullandığı adres ve yönetim adresinden bilerek ayrıldığı noktalar.

Genel Bakış

Müşteri API'si, müşterinin kendi hesabını kendi kodundan yönetmesini sağlar: hizmetleri okumak, fatura ödemek, alan adı sipariş etmek, talep açmak. Anahtar size değil müşteriye aittir ve müşteri onu kendi hesabından üretir.

Eriştiği her şey o tek hesapla sınırlıdır. Kapsam, uygulamayı hatırlamanız gereken bir süzgeç değil; anahtardan gelir ve istekteki hiçbir şey onu genişletemez.

Yönetim adresinin kısıtlanmış bir görünümü değil, ondan ayrı bir üründür. Farklı adres, farklı anahtar türü ve müşterinin panelinde gerçekten yapabildiklerinden kurulmuş daha kısa bir katalog.

Ön Koşullar

Kurulumda bir müşteri hesabı ve o hesaptaki /api-credentials sayfasından üretilmiş bir müşteri anahtarı.
/api/v1/client taban adresi. Buraya gönderilen yönetim anahtarı reddedilir; yönetim adresine gönderilen müşteri anahtarı da öyle.

Yapı

Burada dört şey farklı davranır. Bunları baştan bilmek iki kataloğu yan yana okumaktan kurtarır.

Her sorgu hesaba bağlı Başkasına ait bir kayıt, tam olarak var olmayan bir kayıt gibi 404 döner. İkisi asla ayırt edilmez; bir anahtar komşularını yoklayamaz.

Evrensel değerler kodla taşınır Ülkeler ISO iki harfli kod, para birimleri ISO kodu; hem istekte hem yanıtta. İç sayısal kimlikler bu adresin parçası değildir.

Para bir nesne, tarih düz metin Tutarlar biçimlenmiş metin yerine {amount, currency} olarak gelir, tarihler ise YYYY-AA-GG ya da boş. Biçimlendirme size ait.

Formun seçeceği her şeyin bir arama ucu var Panelin açılır liste sunduğu yerde API bir referans ucu sunar: ülkeler, sonra o ülkenin eyaletleri, sonra o eyaletin şehirleri.

Panelde Kalanlar

Bazı hesap işlerinin hiç ucu yoktur; bu bir eksiklik değil sınırdır. Kart saklama, ödeme sağlayıcısının kendi barındırılan akışını ister. Parola ya da e-posta değiştirmek tek kullanımlık kod ister. İki adımlı doğrulama kurulumu ve kimlik belgeleri insan ister. Veri silme talebi ise hukuki bir karardır.

Bunların durumu yine de okunabilir; entegrasyon bir hesabın doğrulanmış olup olmadığını, doğrulama yetkisi olmadan öğrenebilir.

Örnek

anahtar kime ait

curl -H 'Authorization: Bearer wck_...' \
     'https://panel.example.com/api/v1/client/whoami'
# {"data":{"id":3,"type":"client","owner_id":42,"permissions":["Services/*"]}}

curl -H 'Authorization: Bearer wck_...' \
     'https://panel.example.com/api/v1/client/services?limit=10'

Tuzaklar

Operatör aracını müşteri anahtarları üzerine kurmayın

Tek entegrasyondan çok müşteriye hizmet vermek, müşteri başına bir anahtar demektir ve her birini o müşteri üretir. Hesaplar arası iş yapmanız gerekiyorsa doğru yer yönetim adresidir. Bunu taklit etmek için müşterilerin anahtarlarını toplamak, üstlenmek istemeyeceğiniz bir sorumluluktur.

Ödeme ya bakiye ya saklı kart, başka bir şey değil

Sipariş ve ödeme, hesap bakiyesini ya da müşterinin daha önce sakladığı bir kartı kabul eder. Yönlendirme, çerçeve ya da 3D Secure adımı gerektiren sağlayıcı akışları panele aittir. Reddedilen bir kart yine 200 döner ve üzerinde başarısız bir ödeme taşır; yalnız HTTP kodunu değil ödeme durumunu da okuyun.

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