API Meta Graph — клиентские бизнес-процессы, связанные с приложениями | Документация для разработчиков
API метаграфа — приложения, подключенные к клиентским бизнес-процессам
Экземпляр для программы магистратуры (LLM)
Версия
API для получения информации о подключенных клиентских компаниях, связанных с приложением Meta.
Этот конечный пункт позволяет приложениям получать информацию о компаниях, которые имеют
Установленные клиентские соединения через приложение. Это необходимо для управления
деловые отношения и понимание бизнес-моделей клиентов.
GET /{Version}/{Application-ID}/connected_client_businesses
Получить список компаний-клиентов, подключенных к указанному приложению.
Варианты использования:
Мониторинг взаимоотношений между приложением и бизнес-клиентом
Проверьте конфигурации подключенных бизнес-процессов
Получить информацию о состоянии и деталях подключения к бизнес-сети
Управление доступом и правами доступа клиентов к бизнес-ресурсам
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Данные о подключении к корпоративной сети могут кэшироваться в течение умеренного времени, но информация о состоянии может изменяться.
Внедрите соответствующие стратегии аннулирования кэша.
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Строка идентификатора приложения · обязательный
Идентификатор вашего метаприложения. Этот идентификатор присваивается при создании приложения
и его можно найти на панели управления вашего приложения.
Параметры запроса
поля строка
Список полей, разделенных запятыми, которые необходимо включить в ответ. Если не указано иное,
Будут возвращены поля по умолчанию (id, name, verification_status, business_status).
Доступные поля: id, name, verification_status, business_status, created_time, updated_time
limit integer [min: 1, max: 100]
Максимальное количество подключенных клиентских компаний, отображаемых на одной странице. По умолчанию — 25, максимум — 100.
после строки
Курсор для постраничной навигации. Используйте его, чтобы перейти на следующую страницу результатов.
перед строкой
Курсор для постраничной навигации. Используйте его, чтобы перейти на предыдущую страницу результатов.
Ответы
Получить список компаний-клиентов, подключенных к указанному приложению.
Варианты использования:
Мониторинг взаимоотношений между приложением и бизнес-клиентом
Проверьте конфигурации подключенных бизнес-процессов
Получить информацию о состоянии и деталях подключения к бизнес-сети
Управление доступом и правами доступа клиентов к бизнес-ресурсам
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Данные о подключении к корпоративной сети могут кэшироваться в течение умеренного времени, но информация о состоянии может изменяться.
Внедрите соответствующие стратегии аннулирования кэша.
200
Успешно получены данные о связанных клиентских компаниях
Тип содержимого: application/json
Схема: ConnectedClientBusinessesResponse
Показать дочерние атрибуты
Ответ ConnectedClientBusinesses
данных ConnectedClientBusiness
Множество взаимосвязанных клиентских предприятий
Показать дочерние атрибуты
данные[] ConnectedClientBusiness
Информация о бизнес-процессах и конфигурация подключенных клиентов
Показать дочерние атрибуты
строковый идентификатор · обязательный
Уникальный идентификатор для подключенного клиентского бизнеса
строка имени · обязательный
Название компании-клиента, к которой подключен клиент
статус_верификации BusinessVerificationStatus
Статус проверки подключенного клиентского бизнеса
бизнес-статус BusinessStatus
Текущее состояние бизнеса подключенных клиентов
created_time строка (дата-время)
Отметка времени создания делового соединения
updated_time строка (дата-время)
Отметка времени последнего обновления данных в системе
навигация КурсорСтраничная
Информация о постраничной навигации на основе курсора
Показать дочерние атрибуты
объект курсоров
Показать дочерние атрибуты
перед строкой
Курсор, указывающий на начало страницы данных
после строки
Курсор указывает на конец страницы данных
предыдущая строка
URL предыдущей страницы результатов
следующая строка
URL для следующей страницы результатов
400
Неверный запрос — недопустимые параметры или некорректный формат запроса
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
401
Несанкционированный доступ - Недействительный или отсутствующий токен доступа
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
403
Запрещено — Недостаточные права доступа или отказ в доступе
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
404
Приложение не найдено — идентификатор приложения не существует или недоступен
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
422
Необрабатываемый объект — Параметры запроса действительны, но не могут быть обработаны
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
429
Слишком много запросов — превышен лимит запросов
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
500
Внутренняя ошибка сервера — Неожиданная ошибка сервера
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
Выберите язык
Выберите код состояния
Аутентификация
|
Схема |
Тип |
Расположение |
|
bearerAuth |
HTTP Bearer |
Заголовок: Авторизация |
Примеры использования
bearerAuth:
Включите
Authorization: Bearer your-token-here в заголовки запроса.Глобальные требования к аутентификации
Для работы всех конечных точек требуется:
bearerAuth
Комментарии отсутствуют
Комментарии отсутствуют