🔑 API Keys
Dis uygulamalarin panele programatik erisebilmesi icin API anahtari (API Key) olusturabilirsiniz. Her anahtar, belirlediginiz yetki kapsamina gore panelin endpointlerine erisebilir.
API Key Olusturma
- Profil → API Keys bolumune gidin.
- Yeni Anahtar Olustur butonuna basin.
- Anahtara aciklayici bir isim verin (ornegin: Deploy Scripti, CI/CD Pipeline).
- Gerekirse izin kapsamini secin (okuma, yazma vb.).
- Olusturulan anahtari kopyalayin — bir daha gosterilemez.
Kimlik Dogrulama
Her API isteğinde anahtarinizi Authorization basliginda gonderin:
Authorization: Bearer cpk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Ornek API Istekleri
# Tum zone'lari listele
curl -X GET \
https://security.netguc.com/api/v1/zones \
-H "Authorization: Bearer cpk_xxx..."
# Belirli bir zone'un DNS kayitlarini getir
curl -X GET \
https://security.netguc.com/api/v1/zones/{zone_id}/dns \
-H "Authorization: Bearer cpk_xxx..."
# Yeni DNS kaydi ekle
curl -X POST \
https://security.netguc.com/api/v1/zones/{zone_id}/dns \
-H "Authorization: Bearer cpk_xxx..." \
-H "Content-Type: application/json" \
-d '{"type":"A","name":"sub","content":"1.2.3.4","proxied":true,"ttl":1}'
# Cache temizle
curl -X DELETE \
https://security.netguc.com/api/v1/zones/{zone_id}/cache \
-H "Authorization: Bearer cpk_xxx..."
API Cevap Formati
{
"success": true,
"data": { ... },
"message": null,
"errors": []
}
HTTP Hata Kodlari
| Kod | Anlami |
|---|---|
200 | Basarili |
201 | Kaynak olusturuldu |
400 | Gecersiz istek parametresi |
401 | Kimlik dogrulama hatasi — gecersiz veya eksik API Key |
403 | Yetki yetersiz — Key bu isleme izin vermiyor |
404 | Kaynak bulunamadi |
429 | Cok fazla istek — rate limit asimi |
500 | Sunucu hatasi |
Rate Limiting
API anahtari basina dakikada maksimum 60 istek gonderilebilir. Limiti asmaniz durumunda 429 Too Many Requests cevabiyla karsilasilir. Cevap basligindaki Retry-After degeri ne kadar beklenecegini belirtir.
Guvenlik: API anahtarlarinizi kaynak kod deposuna (GitHub vb.) eklemeyin. Ortam degiskeni (
.env) veya gizli anahtar yonetimi (vault) kullanin.Tum endpointler icin API Referansi sayfasini inceleyin.