API Kimlik Doğrulama ve İzinler

Anahtar nasıl üretilir, istekte nasıl taşınır ve izinleri nereye erişebileceğine nasıl karar verir.

Genel Bakış

Kimlik isteyen her çağrı yalnızca bir API anahtarı taşır. Oturum ve çerez yok, dolayısıyla çağrı bir sunucudan da dizüstünden de tarayıcı sekmesinden de aynı davranır.

Anahtar üç şey tutar: ait olduğu adres, kendisine verilen izin listesi ve dakika başına istek bütçesi. Üçü her istekte bu sırayla kontrol edilir; hayır diyen ilki çağrıyı bitirir.

Anahtarın kendisi saklanmaz. Kurulumda duran şey, onun özeti ve gösterim için ilk birkaç karakteridir. Kaybolan bir anahtar panelden geri alınamaz, yalnızca yenisiyle değiştirilir.

Ön Koşullar

• Yönetim anahtarı için panel erişimi, müşteri anahtarı için bir müşteri hesabı.
• Anahtarı saklayacağınız, kaynak kod deponuz olmayan bir yer.

Adım Adım

Anahtar Üretin

1. Yönetim adresi için panelde Ayarlar → API Kimlik Bilgileri ekranını açın ve bir kimlik bilgisi oluşturun.
2. Müşteri adresi için müşteri kendi hesabındaki API Kimlik Bilgileri sayfasından, /api-credentials adresinde oluşturur.
3. Anahtarı onay ekranından kopyalayın. Bir kez gösterilir, bir daha gösterilmez.

İzinleri Verin

1. Anahtarın ihtiyaç duyduğu eylemleri işaretleyin. Her onay kutusu bir Grup/Eylem çiftidir; ucun dokümanındaki adla aynıdır.
2. İşi gören en dar kümeyi verin. Yalnızca fatura okuyan bir anahtar müşterilerinize karşı kullanılamaz.
3. İsterseniz o anahtara özel dakikalık bütçeyi yükseltin ya da düşürün; boş bırakmak kurulum varsayılanı demektir.

Gönderin ve Doğrulayın

1. Anahtarı Authorization: Bearer başlığına koyun; istemciniz bunu kuramıyorsa X-Api-Key başlığını kullanın.
2. Anahtarı ürettiğiniz adreste whoami ucunu çağırın. Anahtarın kimliğini, izinlerini ve müşteri adresinde arkasındaki hesabı döndürür.
3. Buradaki bir 403 anahtarın gerçek ama diğer adrese ait olduğu anlamına gelir. Anahtarı değil adresi kontrol edin.

Referans

Retler bilerek birbirinden ayrıdır; böylece çalışmayan bir entegrasyon üç kontrolden hangisinin onu durdurduğunu size söyler.

Örnek

KEY=$(cat ~/.config/wisecp.key)

curl -H "Authorization: Bearer $KEY" \
     'https://panel.example.com/api/v1/admin/whoami'
# {"data":{"id":7,"type":"admin","name":"Fatura senkronu","permissions":["Invoices/*","Clients/GetClients"]}}

$ch = curl_init('https://panel.example.com/api/v1/admin/whoami');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('WISECP_API_KEY')],
]);

$body = json_decode(curl_exec($ch), true);
curl_close($ch);

$izinler = $body['data']['permissions'] ?? [];

Tuzaklar

İlgili Makaleler

• WISECP API'si
• İstek ve Yanıt Biçimi
• API Kaynakları
• Müşteri API'sine Giriş