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
Neden bu kadar kısıtAnahtar sızsa bile, izinli IP dışından kullanılamaz ve izin verilmeyen uçlara erişemez. Tek başına anahtarı ele geçirmek yeterli olmaz.

Anahtar oluşturma

Entegrasyon — Servis Anahtarı
Servis anahtarı oluşturma formu: yetki ve IP kısıtı alanları
Servis anahtarı — CRM/ERP erişimi için

Anahtar oluştururken doldurulacak alanlar:

AlanAçıklamaZorunlu
AdAnahtarın ne için kullanıldığını anlatan kısa bir adEvet
AçıklamaDaha ayrıntılı notHayır
İzinli IP’lerAnahtarın kullanılacağı adreslerEvet
İzinli uç noktalarErişilebilecek API yollarıEvet
İkisi de zorunluIP ve uç nokta listesi boş bırakılamaz. Bu, kazara "her yerden her şeye erişebilen" bir anahtar üretilmesini engeller.

IP tanımlama biçimleri

İzinli IP alanında üç biçim kullanabilirsiniz:

BiçimÖrnekNe kapsar
Tam adres203.0.113.10Yalnızca o adres
Önek10.90.Bu önekle başlayan tüm adresler
Alt ağ (CIDR)203.0.113.0/24Belirtilen alt ağdaki tüm adresler
Sunucunuzun dış IP’siSunucunuz internete çıkarken farklı bir IP kullanıyor olabilir. Anahtarı tanımlarken sunucunuzun WiChat’e görünen dış IP adresini girin; iç ağ adresi genelde işe yaramaz.

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:

üretilen anahtar (maskeli gösterim)
svc_••••••••••••••••••••••••••••••••••••••••
Yalnızca bir kez gösterilirAnahtar üretildiği anda tam haliyle gösterilir; sonra yalnızca ilk birkaç karakteri görünür. Kaybederseniz yenisini üretmeniz gerekir. Oluşturur oluşturmaz güvenli bir yere kaydedin.

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:

örnek istek
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:

başarılı yanıt
{
  "status": "success",
  "data": { }
}
Kullanacağınız uçlarHangi uç noktaları çağıracağınızı API referansından öğrenebilirsiniz. Anahtarınızın izinli uç listesine yalnızca kullanacaklarınızı ekleyin.

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.

Düzenli kontrol edinUzun süredir kullanılmayan bir anahtar varsa muhtemelen gereksizdir — pasif edin. Beklemediğiniz bir kullanım görürseniz anahtarı hemen iptal edin.

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

BelirtiOlası sebepNe yapmalı
Erişim reddedildiIP izinli listede değilSunucunuzun dış IP adresini izin listesine ekleyin
Erişim reddedildiUç nokta izinli değilÇağırdığınız yolu izinli uç listesine ekleyin
Erişim reddedildiAnahtar pasifAnahtarın durumunu kontrol edin
Anahtar çalışmıyorBaşlık adı yanlışX-Service-Key başlığını kullandığınızdan emin olun
Anahtarı kaybettimAnahtar bir kez gösterilirYeni anahtar üretip sisteminizi güncelleyin
Sonraki adımWiChat’teki olaylardan haberdar olmak için webhook rehberine geçin.