Worldwide (English)
Türkiye (Türkçe)
BaşlangıçErişim ve Yetkilendirme
Bu aşamada, harici ve dahili API kullanımı için erişim ve yetkilendirmenin nasıl gerçekleştirileceği detaylandırılmıştır.
Harici API Kullanımı
- Harici API'ye erişim için "API KİMLİĞİ" oluşturulması zorunludur.
Dahili API Kullanımı
- Dahili API için herhangi bir API kimliği oluşturma gerekliliği bulunmamaktadır.
API Kimliği Oluşturma
Önemli Hatırlatma:
API kullanımı WISECP 3.1.7 sürümü ile mümkündür. Bu nedenle API kullanımından önce WISECP sürümünüzün en düşük 3.1.7 olduğundan emin olunuz. Aksi taktirde yönetim panelinizde API ile ilgili herhangi bir işlev görüntülenmez.
API kullanımı WISECP 3.1.7 sürümü ile mümkündür. Bu nedenle API kullanımından önce WISECP sürümünüzün en düşük 3.1.7 olduğundan emin olunuz. Aksi taktirde yönetim panelinizde API ile ilgili herhangi bir işlev görüntülenmez.
- WISECP Yönetim panelinizdeki menüden "Ayarlar > Genel Ayarlar" seçeneğine gidin.
- "API" sekmesini bulun ve tıklayın.
- "Oluştur" butonuna tıklayarak yeni bir API kimliği oluşturma işlemini başlatın.
İsim:
- API kimliğinize tanımlayıcı bir isim verin. (Büyük, küçük harf, rakam, boşluk, özel karakter içerebilir.)
İzin Verilen IP Adresleri:
- Bu alan opsiyoneldir; eğer doldurulmak istenirse harici API'ye erişebilecek IP adresleri alt alta olacak şekilde girilmelidir.
İzinler:
- Bu alanda en az bir eyleme izin vermeniz gereklidir, eylemlerin ne işe yaradığı hakkında detaylı bilgiye “Eylemler” bölümünden erişebilirsiniz.
Gerekli bilgiler girildikten sonra "Oluştur" butonuna tıklayınız. Sonrasında sayfada beliren "Kopyala" butonuna tıklayarak oluşturulan API anahtarını panoya kopyalayabilrsiniz.
API Anahtarını Tanımlamak
- API isteklerinizi yaparken HTTP isteğinin "Header" bölümünde "Apikey" adı altında API anahtarınızı yerleştirin.
- Ayrıca "Content-Type" başlığı altında veri tipi olarak "application/json" belirtmeniz gerekmektedir.
API URL
- API'nizin URL adresini öğrenmek için yine "Ayarlar > Genel Ayarlar > API" sekmesine gidin. API URL ilgili sayfada görüntülenecektir.
- Genellikle URL formatı şu şekilde görüntülenir: https://example.com/api/ veya https://example.com/index.php/api/
- Belirli bir API eylemi için API URL'nin sonuna "/eylemin_grubu_adi/eylemin adı" ekleyerek tam endpoint bilgisine ulaşabilirsiniz.
Bu adımları takip ederek API erişimi ve yetkilendirme işlemlerinizi güvenle tamamlayabilirsiniz.
Örnek cURL İsteği
curl --location 'https://example.com/api/Clients/ValidateClient' \
--header 'Content-Type: application/json' \
--header 'Apikey: Your API Key' \
--data-raw '{
"email": "[email protected]",
"password": "test123"
}'
