Başlarken
Kimlik doğrulama
ZenWapp External API'nin tüm uçları API anahtarı ile korunur. Oturum çerezi veya OAuth akışı kullanılmaz.
İstek başlığı
Anahtarı her istekte Authorization başlığında bearer token olarak gönderin.
Authorization: Bearer wa_live_xxxxxxxxxxxxxxxxxxxxAnahtar biçimleri
İki önek desteklenir; ikisi de aynı şekilde çalışır:
| Önek | Açıklama |
|---|---|
wa_live_ | Kanal hesabına bağlı canlı anahtar. |
zw_ | Platform genelinde kullanılan anahtar biçimi. |
Yetki modeli
Her anahtar bir yetki kümesi taşır. İstek, ucun gerektirdiği yetkiyi taşımıyorsa 403 forbidden döner. Referanstaki her uç noktanın altında gerekli yetki belirtilmiştir.
| Yetki | Kapsam |
|---|---|
messages:send | Mesaj, medya, şablon, zamanlanmış ve toplu gönderim. |
messages:read | Mesaj geçmişi, kuyruk durumu, limit bilgisi, medya erişimi. |
chats:read | Sohbet ve kişi listeleme, numara kontrolü. |
chats:write | Grup ve etiket oluşturma. |
* | Tüm yetkiler. Yalnızca gerçekten gerekliyse verin. |
En az yetki ilkesi
Bir entegrasyon yalnızca mesaj gönderiyorsa
messages:send yeterlidir. Anahtar sızdığında etki alanı, verdiğiniz yetki kadardır.Hesap kapsamı
Her anahtar tek bir kanal hesabına bağlıdır ve yalnızca o hesabın verisine erişir. Birden fazla numara yönetiyorsanız her numara için ayrı anahtar oluşturun; anahtarın hangi hesaba bağlı olduğunu GET /account ile doğrulayabilirsiniz.
Anahtar güvenliği
- Anahtarı sunucu tarafında saklayın; tarayıcı veya mobil uygulama paketine koymayın.
- Ortam değişkeni veya secret yöneticisi kullanın, koda gömmeyin.
- Depoya yanlışlıkla eklenen anahtarı geçersiz sayın ve panelden hemen silin.
- Farklı ortamlar (test, canlı) için ayrı anahtarlar kullanın.
- Kullanılmayan anahtarları silin — dolaşımdaki her anahtar bir risktir.
Kimlik doğrulama hataları
| HTTP | error | Anlamı |
|---|---|---|
401 | invalid_api_key | Başlık eksik, biçim yanlış ya da anahtar silinmiş. |
403 | forbidden | Anahtar geçerli fakat bu uç için gerekli yetkiye sahip değil. |