Перейти к содержимому
Wbiztool

Начало работы

API проверки учётных данных

Используйте этот API, чтобы проверить учётные данные перед другими вызовами API. Он подтверждает, что ваши client_id и api_key работают вместе, и, при необходимости, что ID номера WhatsApp принадлежит вашему рабочему пространству. Он ничего не отправляет и не расходует кредиты.

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

Тело запроса: JSON или поля формы

Быстрый пример#

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 и 678 своими значениями. Не передавайте whatsapp_client, если хотите проверить только ключ. Где их найти, описано в разделе Аутентификация.

Параметры запроса#

client_idintegerобязательно

Ваш API Client ID из раздела Настройки → API ключи.

api_keystringобязательно

Ваш API-ключ с той же страницы.

whatsapp_clientintegerнеобязательно

ID одного из ваших номеров WhatsApp со страницы настроек WhatsApp. Передайте его, чтобы дополнительно проверить, что этот ID принадлежит рабочему пространству данного API-ключа. Номер, удалённый из панели управления, тоже проходит эту проверку. Проверяется только ID: подключён ли номер, этот параметр не показывает. Для этого используйте Статус подключения.

Ответ#

Успешный запрос возвращает HTTP 200:

{
  "status": 1,
  "message": "Okay",
  "name": "[email protected] - 919876543210"
}
ПолеТипОписание
statusinteger1, если учётные данные действительны, 0 — если нет.
messagestringOkay при успехе, иначе текст ошибки.
namestringИмя пользователя человека, создавшего рабочее пространство. Если вы передали whatsapp_client, после - добавляется телефон этого номера. Присутствует только при успехе.

Ошибки#

Любая ошибка этого endpoint возвращает HTTP 400, кроме нечислового client_id, для которого возвращается HTTP 403. В теле ответа status всегда равен 0:

{ "status": 0, "message": "Auth Error: invalid api key" }
СообщениеКак исправить
Auth ErrorПередайте client_id и api_key в теле POST-запроса — в виде корректного JSON или полей формы. Это сообщение также возвращается, если whatsapp_client не является числом.
Invalid Client IdПередайте client_id целым числом, например 12345.
Auth Error: invalid api keyПроверьте, что ключ существует, не удалён и принадлежит этому client_id.
Invalid WhatsApp Client IDЭтого ID whatsapp_client нет в рабочем пространстве данного API-ключа. Скопируйте ID со страницы настроек WhatsApp.

Проверка доступности API#

/api/v1/status/ — простая проверка работоспособности. Он не требует учётных данных, принимает любой метод и всегда возвращает:

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

Он показывает только то, что API доступен. Ваши учётные данные и подключение номера WhatsApp он не проверяет.

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

Метод health_check() Python-клиента вызывает этот endpoint.

Советы#

  • Проверяйте один раз при настройке: вызывайте этот endpoint, когда пользователь сохраняет учётные данные в вашем приложении, а не перед каждым сообщением. Успешная проверка не означает, что вы можете отправлять сообщения: она не проверяет оставшиеся кредиты и подключён ли ваш номер.
  • Читайте тело ответа при ошибках: ошибки приходят с HTTP 400 или 403, поэтому убедитесь, что ваш HTTP-клиент всё равно разбирает JSON-тело.
  • Удалённые ключи перестают работать сразу: если ключ удалён на странице API ключей, вы получите Auth Error: invalid api key.
  • Следующий шаг: когда учётные данные заработают, отправьте сообщение.