Servis anahtarı
Kendi yazılımınızın WiChat API’sine erişmesi için servis anahtarı kullanılır. Anahtar, hangi IP’lerden ve hangi uçlara erişileceğiyle sınırlandırılır.
Servis anahtarı nedir?
Servis anahtarı, sunucudan sunucuya erişim içindir. Bir operatörün oturumu değil, bir yazılımın kimliğidir. Üç şeyle sınırlanır:
- İzinli IP adresleri — anahtar yalnızca bu adreslerden kullanılabilir
- İzinli uç noktalar — anahtar yalnızca bu uçlara erişebilir
- Durum — anahtar aktif veya pasif olabilir
Anahtar oluşturma
Anahtar oluştururken doldurulacak alanlar:
| Alan | Açıklama | Zorunlu |
|---|---|---|
| Ad | Anahtarın ne için kullanıldığını anlatan kısa bir ad | Evet |
| Açıklama | Daha ayrıntılı not | Hayır |
| İzinli IP’ler | Anahtarın kullanılacağı adresler | Evet |
| İzinli uç noktalar | Erişilebilecek API yolları | Evet |
IP tanımlama biçimleri
İzinli IP alanında üç biçim kullanabilirsiniz:
| Biçim | Örnek | Ne kapsar |
|---|---|---|
| Tam adres | 203.0.113.10 | Yalnızca o adres |
| Önek | 10.90. | Bu önekle başlayan tüm adresler |
| Alt ağ (CIDR) | 203.0.113.0/24 | Belirtilen alt ağdaki tüm adresler |
Uç nokta yetkisi
Anahtarın erişebileceği API yollarını belirlersiniz. Yalnızca gerçekten gereken uçları ekleyin — kullanılmayan bir yetki gereksiz risktir.
Anahtarı saklama
Anahtar oluşturulduğunda svc_ ile başlayan uzun bir metin üretilir:
svc_••••••••••••••••••••••••••••••••••••••••
Anahtarı nerede saklamalı:
- Sunucunuzda ortam değişkeni olarak
- Bir gizli anahtar yöneticisinde
Nerede saklamamalı: kod deposunda, yapılandırma dosyasında düz metin olarak, e-postada, mesajlaşma uygulamasında, dokümanda.
Anahtarı kullanma
İstek gönderirken anahtarı X-Service-Key başlığında iletirsiniz:
curl -X POST "https://chat.wi.tr/chat-gateway/admin/ORNEK-UC" \
-H "X-Service-Key: svc_••••••••" \
-H "Content-Type: application/json" \
-d '{"ornek_alan": "ornek_deger"}'
Yanıtlar tutarlı bir biçimde döner:
{
"status": "success",
"data": { }
}
Kullanım izleme
Anahtarların kullanımı kayıt altına alınır. Hangi anahtarın ne zaman ve hangi uca eriştiği görülebilir; anahtar kartında son kullanım zamanı gösterilir.
Anahtar iptal ve yenileme
Şüphe durumunda hemen pasif edin
Anahtarın sızdığından şüphelenirseniz beklemeden pasif edin; erişim anında kesilir.
Yeni anahtar üretin
Aynı yetkilerle yeni bir anahtar oluşturun.
Sisteminizi güncelleyin
Yeni anahtarı sunucunuzdaki yapılandırmaya yazın.
Eskiyi silin
Yeni anahtarın çalıştığını doğruladıktan sonra eskisini kaldırın.
Sorun giderme
| Belirti | Olası sebep | Ne yapmalı |
|---|---|---|
| Erişim reddedildi | IP izinli listede değil | Sunucunuzun dış IP adresini izin listesine ekleyin |
| Erişim reddedildi | Uç nokta izinli değil | Çağırdığınız yolu izinli uç listesine ekleyin |
| Erişim reddedildi | Anahtar pasif | Anahtarın durumunu kontrol edin |
| Anahtar çalışmıyor | Başlık adı yanlış | X-Service-Key başlığını kullandığınızdan emin olun |
| Anahtarı kaybettim | Anahtar bir kez gösterilir | Yeni anahtar üretip sisteminizi güncelleyin |