İçeriğe geç
ZZenWapp Docs

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_xxxxxxxxxxxxxxxxxxxx

Anahtar biçimleri

İki önek desteklenir; ikisi de aynı şekilde çalışır:

ÖnekAçı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.

YetkiKapsam
messages:sendMesaj, medya, şablon, zamanlanmış ve toplu gönderim.
messages:readMesaj geçmişi, kuyruk durumu, limit bilgisi, medya erişimi.
chats:readSohbet ve kişi listeleme, numara kontrolü.
chats:writeGrup 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ı

HTTPerrorAnlamı
401invalid_api_keyBaşlık eksik, biçim yanlış ya da anahtar silinmiş.
403forbiddenAnahtar geçerli fakat bu uç için gerekli yetkiye sahip değil.