ВойтиНачать бесплатно

Документация для разработчиков

Найдите ресурсы для разработчиков и документацию по API

Просмотр по категориям 5 подкатегории
50 статьи · В этом разделе
API для разработчиков, вебхуки и конструктор соединений — OpsIQ
OpsIQ предлагает надежную платформу для создания управляемых интеграций через свой API для разработчиков, вебхуки и конструктор соединений. Это позволяет разработчикам создавать приложения, работающие с ИИ, с акцентом…
341
Каковы типы возможностей и профили соединителей OpsIQ?
Типы возможностей и профили соединителей OpsIQ Управляющая плоскость интеграции в настоящее время описывает 52 типа возможностей и 7 стартовых профилей. Профиль представляет собой общую форму платформы, такую как…
338
Сколько операций доступно через OpsIQ General API?
Текущие страницы разработчиков и интеграций описывают 1,558 именованных операций General API, регулируемых 62 минимальными областями доступа. Реестр операций гарантирует, что поведение API, документация по действиям…
288
Документация OpsIQ и Документы для Разработчиков — OpsIQ
Обзор Документации OpsIQ и Документов для Разработчиков OpsIQ предоставляет исчерпывающую документацию для пользователей, чтобы эффективно настраивать, управлять и расширять свою платформу. Это включает в себя…
262
Поддерживает ли API OpsIQ идемпотентность?
Да, модель разработчика включает в себя защиту от идемпотентного воспроизведения для записей. Эта функция включает в себя задокументированное 24-часовое окно идемпотентности для поддерживаемых операций. Клиенты должны…
258
Может ли OpsIQ подключаться к пользовательскому бэкенду?
Да, OpsIQ может подключаться к пользовательскому бэкенду. Пользовательский бэкенд может использовать Общий API, вебхуки, Конструктор соединений или явные конечные точки AI Action. Архитектура должна предоставлять только…
241
Могут ли аутентифицированные пользователи перемещаться между порталом OpsIQ и удалённым доменом?
OpsIQ описывает подписанный токен идентичности с кросс-доменным доступом, который основан на ключе сайта, секрете, информации о роли/контексте и ограниченном времени жизни. Этот механизм позволяет удалённому сайту…
239
Работает ли OpsIQ с WHMCS?
Да, OpsIQ работает с WHMCS. Хостинг и WHMCS образуют первоклассное решение. Коннектор WHMCS может предоставить аутентифицированный контекст клиента, услуги, счета, домена, заказа и поддержки, а также открыть одобренные…
236
Доступны ли все интеграции OpsIQ в равной степени?
Нет, не все интеграции OpsIQ доступны в равной степени. Некоторые коннекторы объединены как Общая доступность (GA), в то время как другие объединены как Предварительный просмотр. Кроме того, пакеты на рынке могут иметь…
227
Поддерживает ли OpsIQ интеграции через REST и GraphQL?
Да, OpsIQ поддерживает интеграции через стандартные API в стиле REST или GraphQL. Модель соединителя сосредоточена на возможностях, которые предоставляет внешняя система. Методы аутентификации включают: Bearer API ключ…
224
Руководство администратора и разработчика Portal Studio — OpsIQ
Обзор OpsIQ Portal Studio позволяет вам создавать, предварительно просматривать, управлять, публиковать и расширять корпоративный портал для клиентов. Это руководство предоставляет основную информацию как для…
218
Как работает конструктор соединителей OpsIQ?
Конструктор использует шесть этапов: Идентификация, Аутентификация, Тест соединения, Действия, Триггеры и Обзор. Конструкторы могут начать с OpenAPI, Postman, cURL или выбранного профиля. Варианты аутентификации…
214
Какие форматы справочной информации по SDK и API предоставляет OpsIQ?
OpsIQ предоставляет описание OpenAPI 3.0.3, ресурсы Postman и вспомогательные шаблоны для PHP, Node.js и Python. Это позволяет командам интегрироваться с их предпочтительным стеком технологий, а не полагаться на один…
204
Как работает ограничение частоты API в OpsIQ?
OpsIQ применяет ограничения частоты API на ключ и возвращает информацию об ограничениях в заголовках ответа. Когда лимит превышен, клиенты получают код состояния HTTP 429 вместе с рекомендациями о том, когда повторить…
200
Может ли OpsIQ интегрироваться с Shopify или WooCommerce?
Да, OpsIQ может интегрироваться с Shopify и WooCommerce. Материалы по коммерции и Sales Bridge от OpsIQ описывают схемы интеграции для Shopify и WooCommerce, а также других коммерческих платформ. Связанная коммерция…
199
Сколько канонических исходящих событий вебхуков имеет OpsIQ?
Канонические исходящие события вебхуков в OpsIQ Страница Webhooks & Actions описывает в общей сложности 30 канонических исходящих событий, а также возможность подписки с использованием подстановочных знаков. Конечные…
197
Могу ли я использовать вебхуки для подключения OpsIQ к другому веб-сайту или приложению?
Использование вебхуков для подключения OpsIQ Да, вы можете использовать вебхуки для подключения OpsIQ к другому веб-сайту или приложению. Подписанные вебхуки служат основным методом интеграции, основанным на событиях, в…
193
Могу ли я сгруппировать несколько удаленных сайтов вместе?
Да, удаленные сайты могут иметь групповую идентичность, что помогает многобрендовым или агентским рабочим пространствам организовывать связанные сайты, сохраняя при этом уровень охвата сайта. Группы улучшают навигацию и…
190
Как OpsIQ защищает удаленные HTTP-действия от SSRF?
Удаленные действия используют объявленные конечные точки и включают защиту от подделки серверных запросов (SSRF). Эти меры защиты имеют различные варианты аутентификации, включая Bearer, API ключ, Basic и HMAC. Для…
172
Могу ли я создать собственную интеграцию для OpsIQ?
Да, вы можете создать собственную интеграцию для OpsIQ, используя Connector Builder. Этот инструмент позволяет вам определить идентификацию, аутентификацию, тесты, действия, триггеры и просмотреть метаданные. Вы можете…
167
Каков график повторных попыток вебхуков OpsIQ?
После первой неудачной доставки вебхука последовательность повторных попыток следующая: 1 минута 5 минут 30 минут 2 часа 12 часов После шестой общей попытки доставка помечается как неудачная. История доставки фиксирует…
163
Как подписываются исходящие вебхуки OpsIQ?
OpsIQ подписывает полезные нагрузки исходящих вебхуков, используя HMAC-SHA256 по сырому телу запроса. Он также включает метаданные доставки, такие как временная метка и событие. Получатели должны следовать этим шагам…
154
Как добавить еще один веб-сайт в OpsIQ?
Чтобы добавить еще один веб-сайт в OpsIQ, выполните следующие шаги: Создайте Удаленный сайт с следующими конфигурациями: Метка Домен Группа Конфигурация отслеживания Установите сгенерированный фрагмент, который содержит…
152
Могут ли Удаленные Сайты сообщать о конверсиях продаж в OpsIQ?
Да, Удаленные Сайты поддерживают схемы моста для конверсий продаж, позволяя атрибутировать покупки и другие результаты к правильному сайту и пути. Шаблоны предоставляются для таких сред, как WooCommerce и…
148
Как мне аутентифицироваться в Общем API OpsIQ?
Аутентификация в Общем API OpsIQ Общий API OpsIQ использует ограниченные Bearer API ключи. Важно, чтобы эти ключи имели только минимально необходимые области доступа для их функции. Кроме того, их необходимо хранить в…
145
Что означают GA, Preview или готовность к контракту для соединителя OpsIQ?
Понимание GA, Preview и готовности к контракту для соединителей OpsIQ GA означает Общую Доступность, что означает, что пакет интеграции прошел управление выпуском общей доступности платформы. Preview указывает на то…
137
Что такое удаленные сайты в OpsIQ?
Удаленные сайты позволяют одной рабочей области работать на нескольких веб-сайтах. Каждому сайту присваивается уникальный site_key и скрипт для вставки. Эти сайты сообщают о состоянии и могут иметь собственный брендинг…
135
Интеграции, API и Конструктор Коннекторов — OpsIQ
OpsIQ предлагает надежную платформу для интеграции различных систем через управляемые пакеты, API и подписанные вебхуки. Пользователи также могут создавать, публиковать и продавать коннекторы через рынок OpsIQ. Процесс…
133
Может ли каждый удаленный сайт иметь разный брендинг?
Да, OpsIQ поддерживает брендинг и конфигурацию для каждого сайта, сохраняя сайты в одном рабочем пространстве. Эта функция полезна для групп с несколькими брендами, региональными сайтами или агентствами. Обратите…
118
Может ли проверка безопасности Marketplace отклонить мой соединитель?
Да, Marketplace выполняет статические проверки безопасности на отправленных пакетах соединителей. Существенные находки могут привести к тому, что пакет будет задержан, отклонен или помещен в карантин для дальнейшего…
108
Сколько интеграций и возможностей подключения имеет OpsIQ?
Возможности интеграции и подключения OpsIQ Текущий контрольный уровень интеграции сообщает следующее: 23 упакованных пакета 21 записи на рынке 52 типа возможностей 7 стартовых профилей 1,558 общих действий API Важно…
106
Поддерживает ли API OpsIQ запросы dry-run?
Да, API OpsIQ поддерживает запросы dry-run. Поддерживаемые операции могут использовать поведение dry_run, позволяя интеграторам проверять намерения и параметры без фиксации записи. Эта функция особенно полезна для…
106
Как OpsIQ предотвращает доступ одного удаленного сайта к данным другого сайта?
Как OpsIQ предотвращает видимость данных между удаленными сайтами Записи удаленных сайтов назначаются с конкретной областью сайта, и OpsIQ реализует уровневую область видимости строк, чтобы гарантировать, что данные…
101
Почему я не вижу меню Загрузки?
Меню учитывает права доступа и может быть скрыто, если ваша учетная запись не имеет никаких подходящих продуктов Self-Hosted или если загрузки Self-Hosted отключены. Если вы считаете, что у вас есть активное право на…
73
Какую информацию я могу увидеть о токене API?
Страница API Tokens предоставляет различные детали о каждом токене, включая: Имя токена Публичный идентификатор Предоставленные разрешения Текущий статус Информация о использовании (например, когда он был использован в…
70
Могу ли я временно отключить API токен, не удаляя его?
Да, API Tokens поддерживают отключение и последующее повторное включение токена. Вы можете отключить токен, когда интеграция должна временно прекратить его использование. Пожалуйста, помните, что подключенная интеграция…
70
Могу ли я увидеть свою историю загрузок Self-Hosted?
Да, вы можете просмотреть свою историю загрузок, где доступна функциональность истории загрузок. Функция История загрузок отображает, когда пакет был загружен, вместе с информацией о пакете и версии, деталями файла…
67
Что может появиться в Загрузках Self-Hosted?
Учетная запись может публиковать основной пакет Self-Hosted и, в зависимости от ваших прав и текущей версии, дополнительные интеграционные или разработческие пакеты. Точные пакеты, версии и доступность контролируются…
66
Могу ли я использовать токен OpsIQ API вместо пароля моей учетной записи для интеграции?
Да, вы можете использовать токен OpsIQ API вместо пароля вашей учетной записи для поддерживаемых операций API клиентов. Этот метод предпочтительнее, чем предоставление интеграции с вашим интерактивным паролем учетной…
65
Подписанные вебхуки и действия API для автоматизации — OpsIQ
OpsIQ предлагает надежное решение для автоматизации рабочих процессов с помощью подписанных вебхуков и действий API. С такими функциями, как вебхуки с подписью HMAC, проверенные входящие события и управляемые действия…
64
Как мне установить издание Self-Hosted?
Как установить издание Self-Hosted Чтобы установить издание Self-Hosted, загрузите текущий пакет, доступный для вашего активного права на Self-Hosted. Следуйте инструкциям по установке или быстрому старту…
63
Что такое токены API клиентов в OpsIQ?
Токены API клиентов позволяют вам авторизовать поддерживаемые интеграции с клиентами без необходимости делиться паролем от вашей учетной записи. Эти токены могут иметь ограниченные разрешения для поддерживаемых операций…
54
Кто может скачать программное обеспечение OpsIQ Self-Hosted?
Загрузки доступны для подходящих клиентов Self-Hosted, когда загрузки включены и соответствующая подписка или пробный период активны. Клиенты, использующие только облачные решения, обычно используют свое выделенное…
53
Нужен ли ключ лицензии клиентам Cloud?
Обычный доступ к OpsIQ Cloud основан на рабочем пространстве, принадлежащем клиенту, и его праве, а не на установке ключа лицензии для саморазмещенного хостинга. Ключи лицензий в учетной записи клиента в первую очередь…
53
Что означает 'Не привязан' на лицензии Self-Hosted?
Термин 'Не привязан' указывает на то, что лицензия в настоящее время не имеет записанного доменного связывания в отображении аккаунта. Поведение доменного связывания может варьироваться в зависимости от продукта и…
47
Почему я не могу снова увидеть секрет моего API токена?
Секрет токена намеренно показывается только в момент создания. Учетная запись хранит то, что необходимо для проверки будущего использования токена, а не повторно используемую копию в открытом виде для последующего…
45
Что происходит, когда я удаляю токен API?
Удаление токена навсегда удаляет этот токен клиента из активного использования. Любая интеграция, которая все еще настроена с ним, перестанет аутентифицироваться и должна быть обновлена новым токеном, если доступ все…
43
Как создать токен API клиента OpsIQ?
Чтобы создать токен API клиента OpsIQ, выполните следующие шаги: Откройте раздел Токены API. Создайте токен с описательным именем. Выберите соответствующие доступные разрешения. После создания токена немедленно…
43
Загружает ли ZIP-файл соединителя его немедленно?
Нет, загрузка ZIP-файла соединителя не публикует его немедленно. Когда автор загружает соединитель, создается заявка, которая проходит автоматические проверки и обзор. Публикация соединителя зависит от того…
36
Почему пакет Self-Hosted отображается как недоступный?
Пакет может отображаться как недоступный по двум основным причинам: он не был опубликован для вашего права на использование, или его требования к целостности релиза не были выполнены. Учетная запись намеренно избегает…
18
Все еще нужна помощь?

Наша команда здесь, если вы не можете найти то, что ищете.

Связаться с поддержкой