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

Многопартнерские решения WhatsApp Business — API токенов доступа | Документация для разработчиков

Многопартнерские решения WhatsApp Business — API токенов доступа

Экземпляр для программы магистратуры (LLM)
Версия
API для получения детализированных токенов доступа BISU (Business Integration System User) для партнеров, использующих многопартнерские решения.
Эта конечная точка позволяет партнерам по решениям получать детализированные токены доступа, обеспечивающие безопасный, ограниченный доступ к бизнес-аккаунтам WhatsApp, используемым в их многопартнерском решении.

GET /{Version}/{Solution-ID}/access_token

Получите детализированный токен доступа BISU для доступа к бизнес-ресурсам клиента через многопартнерское решение. Токен обеспечивает безопасный, ограниченный доступ к бизнес-аккаунтам WhatsApp, которые были предоставлены в это решение.
Варианты использования:
Получите защищенные токены доступа для партнерских приложений, чтобы получить доступ к бизнес-ресурсам клиентов
Внедрите многопользовательские партнерские архитектуры с выделенными токенами для каждого клиента
Поддержка безопасной работы API на общих бизнес-аккаунтах WhatsApp
Внедрить надлежащие границы безопасности между различными компаниями-клиентами
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Управление токенами:
Токены доступа имеют ограниченный срок действия и должны обновляться до истечения этого срока. Храните токены безопасно и внедряйте надлежащие стратегии ротации токенов.

Синтаксис запроса

GET /{Version}/{Solution-ID}/access_token
Попробуйте!
Выберите язык

Выберите код состояния

Параметры заголовка
User-AgentСтрока
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
авторизацииСтрока·обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
версииСтрока·обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
идентификатора решенияСтрока·обязательный
Идентификатор вашего многопартнерского решения. Этот идентификатор присваивается при создании решения
и их можно найти в вашей партнерской панели или через API управления решениями.
Параметры запроса
business_idстрока·обязательный
Идентификатор компании-клиента, для которого вы хотите получить токен доступа. Это должно быть
Компания, которая использовала общий бизнес-аккаунт WhatsApp с вашим решением для работы с несколькими партнерами.
Ответы
Получите детализированный токен доступа BISU для доступа к бизнес-ресурсам клиента через многопартнерское решение. Токен обеспечивает безопасный, ограниченный доступ к бизнес-аккаунтам WhatsApp, которые были предоставлены в это решение.
Варианты использования:
Получите защищенные токены доступа для партнерских приложений, чтобы получить доступ к бизнес-ресурсам клиентов
Внедрите многопользовательские партнерские архитектуры с выделенными токенами для каждого клиента
Поддержка безопасной работы API на общих бизнес-аккаунтах WhatsApp
Внедрить надлежащие границы безопасности между различными компаниями-клиентами
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Управление токенами:
Токены доступа имеют ограниченный срок действия и должны обновляться до истечения этого срока. Храните токены безопасно и внедряйте надлежащие стратегии ротации токенов.
200
Успешно получен детализированный токен доступа BISU
Тип содержимого: application/json
Схема: WhatsAppBusinessSolutionAccessToken
Показать дочерние атрибуты

WhatsAppBusinessSolutionAccessToken

access_tokenстрока·обязательный
Детализированный токен доступа BISU для доступа к бизнес-ресурсам клиента

expires_atцелое число (int64)·обязательно
Unix-метка времени, указывающая на дату истечения срока действия токена доступа
400
Неверный запрос — недопустимые параметры или некорректный формат запроса
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты

GraphAPIError

ошибкиобъект·обязательный
Показать дочерние атрибуты

сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке

типстрока·обязательный
Тип категории ошибки

кодцелое число·обязательный
Числовой код ошибки

error_subcodeinteger
Более подробный подкод ошибки, если он доступен

fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta

is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос

error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности

error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
401
Несанкционированный доступ - Недействительный или отсутствующий токен доступа
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты

GraphAPIError

ошибкиобъект·обязательный
Показать дочерние атрибуты

сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке

типстрока·обязательный
Тип категории ошибки

кодцелое число·обязательный
Числовой код ошибки

error_subcodeinteger
Более подробный подкод ошибки, если он доступен

fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta

is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос

error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности

error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
403
Запрещено — Недостаточные права доступа или отказ в доступе
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты

GraphAPIError

ошибкиобъект·обязательный
Показать дочерние атрибуты

сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке

типстрока·обязательный
Тип категории ошибки

кодцелое число·обязательный
Числовой код ошибки

error_subcodeinteger
Более подробный подкод ошибки, если он доступен

fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta

is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос

error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности

error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
404
Решение не найдено — идентификатор решения или идентификатор компании не существует или недоступен
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты

GraphAPIError

ошибкиобъект·обязательный
Показать дочерние атрибуты

сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке

типстрока·обязательный
Тип категории ошибки

кодцелое число·обязательный
Числовой код ошибки

error_subcodeinteger
Более подробный подкод ошибки, если он доступен

fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta

is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос

error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности

error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
422
Необрабатываемый объект — Параметры запроса действительны, но не могут быть обработаны
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты

GraphAPIError

ошибкиобъект·обязательный
Показать дочерние атрибуты

сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке

типстрока·обязательный
Тип категории ошибки

кодцелое число·обязательный
Числовой код ошибки

error_subcodeinteger
Более подробный подкод ошибки, если он доступен

fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta

is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос

error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности

error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
429
Слишком много запросов — превышен лимит запросов
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты

GraphAPIError

ошибкиобъект·обязательный
Показать дочерние атрибуты

сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке

типстрока·обязательный
Тип категории ошибки

кодцелое число·обязательный
Числовой код ошибки

error_subcodeinteger
Более подробный подкод ошибки, если он доступен

fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta

is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос

error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности

error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
500
Внутренняя ошибка сервера — Неожиданная ошибка сервера
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты

GraphAPIError

ошибкиобъект·обязательный
Показать дочерние атрибуты

сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке

типстрока·обязательный
Тип категории ошибки

кодцелое число·обязательный
Числовой код ошибки

error_subcodeinteger
Более подробный подкод ошибки, если он доступен

fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta

is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос

error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности

error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
Выберите язык

Выберите код состояния

Аутентификация

Схема
Тип
Расположение
bearerAuth
HTTP Bearer
Заголовок: Авторизация

Примеры использования

bearerAuth:
Включите Authorization: Bearer your-token-here в заголовки запроса.

Глобальные требования к аутентификации

Для работы всех конечных точек требуется:
bearerAuth