İçeriğe geç
WbizTool

Başlarken

Kimlik bilgilerini kontrol etme API'si

Diğer API çağrılarını yapmadan önce kimlik bilgilerinizi doğrulamak için bu API'yi kullanın. client_id ve api_key değerlerinizin birlikte çalıştığını ve isteğe bağlı olarak bir WhatsApp numara ID'sinin çalışma alanınıza ait olduğunu doğrular. Hiçbir şey göndermez ve mesaj olarak sayılmaz.

POSThttps://wbiztool.com/api/v1/me/

Gövde: JSON veya form alanları

Hızlı örnek#

curl -X POST https://wbiztool.com/api/v1/me/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678
  }'

12345, YOUR_API_KEY ve 678 değerlerini kendi değerlerinizle değiştirin. Yalnızca anahtarı test etmek istiyorsanız whatsapp_client alanını göndermeyin. Bu değerleri nerede bulacağınız için Kimlik doğrulama bölümüne bakın.

İstek parametreleri#

AuthorizationheaderÖnerilir

Bearer YOUR_API_KEY: Ayarlar → API anahtarları sayfasındaki API anahtarınız. Bu başlıkla client_id ve api_key gövdeden çıkarılabilir; ikisi birden gönderilirse başlıktaki geçerli anahtar kullanılır. Bkz. Anahtarı başlıkta gönderin.

client_idintegerAuthorization başlığı olmadan

Ayarlar → API anahtarları sayfasındaki API Client ID'niz. Başlıkla isteğe bağlıdır; gönderirseniz anahtarın çalışma alanına ait olmalıdır.

api_keystringAuthorization başlığı olmadan

Aynı sayfadaki API anahtarınız; başlıkta göndermediğinizde.

whatsapp_clientintegeristeğe bağlı

WhatsApp ayarları sayfasındaki WhatsApp numaralarınızdan birinin ID'si. ID'nin bu API anahtarının çalışma alanına ait olduğunu da kontrol etmek için gönderin. Panelden sildiğiniz bir numara da bu kontrolden geçer. Yalnızca ID'yi kontrol eder; numaranın bağlı olup olmadığını söylemez. Bunun için Bağlantı durumu endpoint'ini kullanın.

Yanıt#

Başarılı bir istek HTTP 200 döndürür:

{
  "status": 1,
  "message": "Okay",
  "name": "[email protected] - 919876543210"
}
AlanTürAçıklama
statusintegerKimlik bilgileri geçerliyse 1, değilse 0.
messagestringBaşarıda Okay, aksi halde hata mesajı.
namestringÇalışma alanını oluşturan kişinin kullanıcı adı. whatsapp_client gönderdiyseniz, numaranın telefonu - ifadesinden sonra eklenir. Yalnızca başarıda bulunur.

Hatalar#

Bu endpoint'teki her hata HTTP 400 döndürür (bir GET isteği 405, dahili bir hata 500 alır). Gövdede status her zaman 0 olur:

{ "status": 0, "message": "Auth Error: invalid api key" }
MesajNasıl düzeltilir
Auth Error - Please send correct API key and Client idclient_id ve api_key değerlerinin ikisini de bir POST gövdesinde, geçerli JSON veya form alanları olarak gönderin.
Invalid client id.client_id değerini 12345 gibi bir sayı olarak gönderin.
Auth Error: invalid api keyAnahtarın mevcut olduğunu, silinmediğini ve bu client_id değerine, yani API anahtarları sekmesindeki Client ID'ye ait olduğunu kontrol edin.
This API key is not linked to a workspace. Create a new API key in WbizTool.Anahtar eski bir hesap yapısından geliyor. API anahtarları sekmesinde yeni bir anahtar oluşturun.
Invalid WhatsApp Client IDBu whatsapp_client bir sayı değil ya da bu anahtarın çalışma alanındaki bir numaraya ait değil. Numaranın ID … ⧉ değerini WhatsApp numaraları sayfasından kopyalayın.
Method not allowed, use POSTBir POST isteği gönderin (HTTP 405).

API'nin çalıştığını kontrol etme#

/api/v1/status/ basit bir erişilebilirlik kontrolüdür. Kimlik bilgisi gerektirmez, her yöntemi kabul eder ve her zaman şunu döndürür:

{ "status": 200, "data": {} }

Yalnızca API'ye erişilebildiğini söyler. Kimlik bilgilerinizi veya WhatsApp numaranızın bağlı olup olmadığını kontrol etmez.

curl https://wbiztool.com/api/v1/status/

Python istemcisinin health_check() yöntemi bu endpoint'i çağırır.

İpuçları#

  • Kurulumda bir kez kontrol edin: bu endpoint'i her mesajdan önce değil, bir kullanıcı uygulamanızda kimlik bilgilerini kaydettiğinde çağırın. Başarılı bir kontrol gönderim yapabileceğiniz anlamına gelmez: planınızın mesajlarına veya numaranızın bağlı olup olmadığına bakmaz.
  • Hatalarda gövdeyi okuyun: hatalar HTTP 400 olarak döner; bu yüzden HTTP istemcinizin JSON gövdesini yine de ayrıştırdığından emin olun.
  • Silinen anahtarlar hemen çalışmayı durdurur: bir anahtar API anahtarları sayfasında silindiyse Auth Error: invalid api key hatası alırsınız.
  • Sonraki adım: kimlik bilgileriniz çalıştığında bir mesaj gönderin.