Руководства

API-ключи

Чтобы пользоваться API Wbiztool или интеграцией, которая запрашивает ваши учётные данные, вам понадобятся три значения из панели управления:

Учётные данные	Поле API	Где найти
API Client ID	`client_id`	Настройки → API ключи, вверху страницы
API-ключ	`api_key`	Настройки → API ключи
ID клиента WhatsApp	`whatsapp_client`	Столбец ID клиента WhatsApp в настройках WhatsApp

Перед началом работы#

Чтобы видеть, создавать или удалять API-ключи, вы должны быть администратором рабочего пространства. См. Роли и права доступа.
Сначала выберите нужное рабочее пространство. Ключи принадлежат рабочему пространству, выбранному в момент их создания, и API-запросы с ключом выполняются в этом рабочем пространстве. См. Переключение рабочего пространства.
Демо-аккаунты не могут использовать API.

Где найти API Client ID#

Откройте Настройки → API ключи. Карточка Обзор API показывает ID клиента API: и число после него. Используйте это число как client_id в каждом запросе. Оно одинаково для всех ключей рабочего пространства.

Создание API-ключа#

Откройте «API ключи»
Перейдите в Настройки и нажмите вкладку API ключи или сразу откройте /settings/#api-keys.
Создайте ключ
В разделе Новый API ключ нажмите Создать новый. Сообщение об успехе подтвердит, что ключ создан, и он появится в таблице.
Скопируйте ключ полностью
Столбец API ключ показывает только начало и конец каждого ключа. Нажмите кнопку копирования рядом с ним (Скопировать полный API ключ), чтобы скопировать ключ целиком, а затем вставьте его в своё приложение или интеграцию.

Ключи получают названия автоматически по количеству ключей в рабочем пространстве (API Key 1, API Key 2 и так далее), и переименовать их нельзя. После удаления ключа новый ключ может получить то же название, что и уже существующий, поэтому различайте ключи по первым и последним символам и по дате в столбце Создано. Срок действия ключей не ограничен: ключ работает, пока вы его не удалите.

Лимит#

В рабочем пространстве одновременно может быть не более 10 API-ключей. Когда лимит достигнут, вы увидите «You have reached the maximum limit of 10 API keys per organization.» (Достигнут максимальный лимит — 10 API-ключей на организацию). Чтобы создать новый ключ, удалите тот, которым больше не пользуетесь.

Таблица API-ключей#

Столбец	Значение
Метка	Название ключа, например API Key 1.
API ключ	Первые и последние символы ключа. Чтобы получить ключ целиком, используйте кнопку копирования.
Создано	Дата создания ключа.
Статус	Всегда Активный. Удалённые ключи убираются из таблицы.
Действия	Удалить удаляет ключ.

Удаление API-ключа#

Найдите ключ
На странице Настройки → API ключи найдите ключ в таблице.
Удалите его
Нажмите Удалить, затем Да, удалить API ключ.

Удаление ключа нельзя отменить. Любое приложение, которое ещё использует этот ключ, сразу перестаёт работать и получает Auth Error: invalid api key. Сначала обновите приложения, указав новый ключ.

ID клиентов WhatsApp#

У каждого подключённого номера WhatsApp есть свой ID. Большинству эндпоинтов для отправки сообщений он нужен в поле whatsapp_client, чтобы выбрать номер, с которого будет отправлено сообщение.

Откройте настройки WhatsApp и посмотрите столбец ID клиента WhatsApp рядом с каждым номером. Если вы ещё не подключили номер, см. Подключение номера WhatsApp.

Проверка учётных данных#

Вызовите проверку учётных данных (POST /api/v1/me/) со своими client_id и api_key и, при необходимости, whatsapp_client. Этот запрос подтверждает, что значения работают вместе, ничего не отправляя и не расходуя сообщения. Если whatsapp_client не принадлежит рабочему пространству, в ответе будет Invalid WhatsApp Client ID.

Если API-ключ утёк#

Любой, у кого есть ваш API-ключ и API Client ID, может отправлять сообщения с ваших номеров WhatsApp и расходовать сообщения вашего рабочего пространства.

Создайте ключ на замену
На странице Настройки → API ключи нажмите Создать новый и скопируйте новый ключ.
Обновите приложения
Замените старый ключ во всех приложениях и интеграциях, которые его использовали.
Удалите утёкший ключ
Нажмите Удалить у утёкшего ключа. Он сразу перестанет работать.
Проверьте, не было ли злоупотреблений
Просмотрите последние сообщения в разделе Отчёты и найдите те, которые вы не отправляли.

Также считайте секретным письмо «WbizTool Alert - WhatsApp Connected Successfully!»: оно отправляется создателю рабочего пространства при первом подключении номера и может содержать один из ваших API-ключей.

Устранение неполадок#

Проблема	Что проверить
Вкладка API ключи показывает API ключи не найдены, хотя ключи есть	Вы не являетесь администратором в этом рабочем пространстве, или выбрано другое рабочее пространство.
«You don't have permission to create API keys in this space.» (У вас нет прав на создание API-ключей в этом пространстве)	Создавать и удалять ключи могут только администраторы. Кнопка Сгенерировать новый API ключ в пустой таблице видна всем, но работает только для администраторов.
«You have reached the maximum limit of 10 API keys per organization.» (Достигнут максимальный лимит — 10 API-ключей на организацию)	Удалите ключ, которым больше не пользуетесь.
`Auth Error: invalid api key`	Ключ удалён или введён с ошибкой, либо `client_id` не относится к тому же рабочему пространству, что и ключ. Если новый ключ и API Client ID, указанный на странице, всё равно не работают, обратитесь в поддержку (в старых рабочих пространствах может отображаться API Client ID, который работает только с ключами, созданными создателем рабочего пространства).
`Auth Error - Please send correct API key and Client id`	В запросе отсутствует `api_key`.
`Invalid client id.` (или `Invalid Client Id` в некоторых эндпоинтах)	`client_id` отсутствует или не является числом. В проверке учётных данных при отсутствии `client_id` или `api_key` возвращается просто `Auth Error`; `Invalid Client Id` там означает, что значение не является числом. Скопируйте его из карточки Обзор API.
Запросы выполняются не в том рабочем пространстве	Ключ был создан в другом рабочем пространстве. Переключитесь на нужное рабочее пространство и создайте ключ там.
`Demo Account can not access apis`	Демо-аккаунты не могут использовать API. Зарегистрируйте бесплатный аккаунт.