Платформа розробника · REST · webhooks · SDKs

Зробіть свій майданчик АІ-оперативний.

OpsIQвиводить чистий RESTAPI, HMAC-призначені webhooks, реєстр дії та готові до застосування SDK. Визначте, які події пожежі з вашої системи, які дії AI дозволено запустити, і які дані безпечні для читання.OpsIQручка підписів, резиденцій, журналів перевірок та потоків підтвердження для Вас.

HMAC-SHA256 як способиPHP · Nde · Python SDKsКРОК3.0.3договірна100% Освітлення аудиту
Зареєстрований запит
З'явився веб-сайт 200 OK
ЦЕНА ЗА ЧАС: укр OpsIQ → підписаний вебхоок POST /v1/actions/run X-OpsIQ-Сигност { "action": « рефінансування_ рахунку », "підтверджений": true } ВЕРІФІК · РУН · АУДИ підпис ✓ роль + сфера ✓ аудит ряд письмовий Віджет @opsiq/sdk ("action. executed") Перевірка HMAC → ручка 200 Охоронно-правова
3Офіційні SDKs: PHP, Node, Python
ХМАКSHA-256 підписано на будь-який запит
40+універсальні події для підписки
100%аудит-логове покриття на дії
Термін служби запиту

Запитати Визначений вебхоок.

Ви замовляєте доOpsIQ APIз вашими масштабованими ключами ведмедя.OpsIQперевіряє обсяг і роль, веде договірну дію, пише аудиторський ряд - після чого виводить HMAC-підписаний вебхоок назад до кінцевої точки. Кожен хмелю автентифікований, idempotent і перерозподіляється на відмову.

Веб-сайт HMAC-SHA256 - вхідні та вихідні навантаження на вебху підписуються над сирим тілом; API дзвінки автентичні з за розміром ключа Bearer.
Автоматичні рети - не вдалося виставити відправлення і птиця, з ідентифікатором доставки ви можете слідувати.
ключі від Idempotency - релей-безпечний дизайн, тому перерозподілений доставка ніколи не подвійних ударів.
Ваше додаток POST /v1/actions/run X-OpsIQ-Сигност X-OpsIQTimestamp ВЕРІФІК - РУН - АУДІТ Ваше кінцеве POST /webhooks Перевірка HMAC 200 Охоронно-правова перевірений підпис обсяг + контроль ролі договірна робота аудит ряд письмовий SIGNED ВЕБ-ХОША ПЛАТА { "Події": "action. executed", "Дельєйрі_id": « dlv_ 8f2a9 », "Ідемпотенції": « idem_ 31c7 », "Виставка": "Ша256=9c4e0a7b ..." } доставляння
01 Підписатись на розсилку 02 Перевірка HMAC 03 договір 04 записувати ряд аудиту 05 Підписано вебхоок
Швидкий запуск

Від нуля до інтеграції в життя чотири кроки.

Сформуйте ключ, ввімкніть перший захід, підпишіться на вебок, зареєструйте дію. Ви можете запустити всю петлю проти пісочниці доторкнувшись даних про виробництво.

Консоль SandboxЗ'єднання
ДЕВЕЛОП КОНСОЛЕ · пісочниця 1 · Генерувати ключ opq_live_xxx · один об'ємний ключ Bearer 2 · Вогонь події POST /v1/events/fire "замовлення. shipped" 3__ Підписатися на сайт https://api.you.com/webhooks_ 4_ Зареєструвати дію saas. refund_invoice · аудит
ПромоSandbox → виробництво, той же код
01

Отримати ключ

Підпишіться на розсилку та створюйте об'ємний підшипник API ключ (opq_…) в налаштуваннях розробника і дають можливість кожній інтеграції тільки поверхонь, які вона потребує.

02

Вогнетривкий & Підключай

ПІДПИСАТИ підписану events/fire (або використовуватиSDK), потім вкажіть будь-якийURLв будь-якому випадку, підписаному з доставкою і зворотним зв'язком.

03

Зареєструвати дію

Зареєструвати підписаний договір дій, щоб AI безпечно працювати з операціями, з контрольними перевірками, політикою підтвердження та повним ходом аудиту.

Як вона вписується разом

Один роз'єм візерунком. П'ять чистої примітивів.

У будь-якому місці, що знаходиться в роз'ємі. OpsIQ ядро залишається загальним, AI залишається передбачуваним, і ваша інтеграція залишається слуховим.

01
Тригери

Про насOpsIQЩо б сталося.

Вогневих універсальних подій з платформи - або власних користувацьких імен. Кожен абонент реагує в режимі реального часу, в пріоритетному порядку.

Посилання на захід
invoice.paid події. багаття() АІ мозковийАктуальність ПравилаГоловна 20 дзеркалаписати перший вебкаПідписка
Універсальні + спеціальні заходиinvoice.paid, ticket.created, subscription.cancelled, customer.signed_up або самостійно. ВідеоспостереженняСиндром AI, правила автоматизації, дзеркальні роз'єми та кінцеві точки вебхока. Порядок деннийВизначте складне відправлення, що дозволяється написати до оповіщення про пожежу.
02/ Договір про дії

Про насOpsIQЩо допускається АІ.

Укладений договір дії - це підписаний JSON__ Декларація: що робить дію, які ролі можуть працювати, які параметри, які він приймає, чи потрібен підтвердження, і кінцева точка виклику.

Дія schema
АІ не може заборонити діїВи можете звернутися до всіх, хто зареєструється. Політика конфіденційностіРизикові дії запускають карту попереднього перегляду перед будь-яким побічним ефектом. Роль + поверхневе покриттяКожна дія визначає ролі і поверхні, що дозволяють її запустити.
Договір про акцію - JSON_
{
  "key": "saas.refund_invoice",
  "label": "Refund a paid invoice",
  "surface": ["admin"],
  "roles": ["owner", "billing_admin"],
  "requires_confirmation": true,
  "params": {
    "invoice_id": { "type": "int", "required": true },
    "reason": { "type": "string", "max": 500 }
  },
  "endpoint": "https://api.you.com/refund",
  "audit": true
}
03_ Підписані вебоки

Поштовхувати події у вашому стеці - з криптографічним доказом.

Підписайтесь на будь-який захід URL____ до будь-якого заходу. OpsIQ_ POSTs theJSON_pload підписано з HMAC-SHA256 над сирим органом - перевірте його в декількох рядочках.

Захист релейІдентифікатор доставкиЗадня рети
Посилання на веб-сайт
php - Українська
$raw = file_get_contents('php://input');
$sig = $_SERVER['HTTP_X_OPSIQ_SIGNATURE'] ?? '';
$expected = hash_hmac('sha256', $raw, $secret); // hex digest, no prefix
if (!hash_equals($expected, $sig)) http_response_code(401);
$event = json_decode($raw, true);
04 / СДК

Ви вже використовуєте.

Три офіційних SDKs ручать автентифікацію, підписку, ключів та відповідей на вибір. Або без обмежень - кожен SDK - це тонка обгортка навколо тієї ж поверхні REST.

Приклади клієнтів
import { OpsIQ } from "@opsiq/sdk";
const ops = new OpsIQ({ apiKey: process.env.OPSIQ_KEY });

await ops.events.fire("order.shipped", {
  customer_id: 421,
  order_ref: "NB-9182",
  carrier: "DHL"
});

const result = await ops.actions.run("saas.send_kb_link", {
  ticket_id: 5519,
  article: "how-to-reset-password"
});
use OpsIQ\Client;

$ops = new Client([
  'api_key' => getenv('OPSIQ_KEY'),
]);

$ops->events->fire('order.shipped', [
  'customer_id' => 421,
  'order_ref' => 'NB-9182',
]);

$result = $ops->actions->run('saas.send_kb_link', [
  'ticket_id' => 5519,
  'article' => 'how-to-reset-password',
]);
from opsiq import OpsIQ

ops = OpsIQ(
    api_key=os.environ["OPSIQ_KEY"],
)

ops.events.fire("order.shipped", {
    "customer_id": 421,
    "order_ref": "NB-9182",
})

result = ops.actions.run("saas.send_kb_link", {
    "ticket_id": 5519,
    "article": "how-to-reset-password",
})
ФІНАНС8.4+Нед.js18+Письмовий3.10+ІНВЕСТ · КРАЙП 3.0.3
05 / Роз'єм шаблон

Побудувати один раз. Вбудувати в будь-який час.

Роз'єм є папкою з одним класом PHP. OpsIQвідкриває його, реєстру веде події, і ваш обліковий запис, який знаходиться в певній мірі, відокремлюється від ядра.

Керівництво з роз'єму
П'ять гачківidentityProviders(), contextProviders(), registerActions(), subscribers(), handleWebhook(). Маніфест-драйвactions.json і settings.json засвідчуйте контракти та налаштування. АвторозкритіВвімкніть папку, встановіть її, ввімкніть його в адмінці.
Від неприпустимого до безпечного дій

Плайн-англійці в. Проведено аудит роботи.

OpsIQ ніколи не заявляє право називати. Проходить через зареєстровані договори, готує перевантаження, просить підтвердження при необхідності його дії та випускає повну аудиторську серію при виконанні, тому AI може бути надана можливість отримати підтвердження, коли дія вимагає її, і видає повний аудитовий ряд при виконанні, тому AI, який може бути здійснений в результаті виконання, тому AI, що може бути надана в дію. ТРК не стає штучним інтелектом, що не може бути довірою.

Договірне перевезення. Зареєстровані дії AI пропонують тільки ті, які ви зареєстрували.
Підтвердіть перед побічними ефектами. Ризикові дії на поверхню попереднього перегляду картки першим.
Сума. Кожен запит, відповідь та результат дій, який захопив історію AI.
4 крокиintent → аудит
ХМАКПідписатися на виконання
"Повернення останнього рахунку Адама" Крок 1 · неухильно → збіг: saas. refund_invoice .: admin · роль: власник · Крок 2_ Крок 3 · Підтвердити та зареєструвати Попередня картка · рахунок-фактура #8421 Підтвердження Кроки4· Аудиторський ряд Эксперт · выпуск · 412ms_ Власники-тільки · експортовані як CSV
Не придумайте дзвінкиРеєструаційний рахунок тільки
Підтвердитипопередній перегляд перед побічними ефектами
100% перевіреноПідказка + відповідь + результат
Контакти

APIнапилення на погляд.

Кожен основний кінцевий пункт, його аут, idempotency і ліміт швидкості ключа. Повний договір, що працює в OpenAPI 3.0.3посилання.

Контакты 3.0.3_ посилання
ВПАутиІдемпотентОбмеження курсу
НаписатиОзначені бічні ефективні поверхні
POST /v1/events/fireХМАКЦЕНА ЗА ЧАС1000/ хв
POST /v1/actions/runХМАКЦЕНА ЗА ЧАС200/ хв
POST /v1/webhooks/testХМАКЦЕНА ЗА ЧАС60/ хв
Читати даліКонтекст, квитки та роз'єм інвентарю
GET /v1/customers/{id}ХМАКЦЕНА ЗА ЧАС2000/ хв
GET /v1/ticketsХМАКЦЕНА ЗА ЧАС2000/ хв
GET /v1/connectorsХМАКЦЕНА ЗА ЧАС2000/ хв

Обмеження ставок на ключ і повернулися на кожну відповідь X-OpsIQ-RateLimit-Remaining; перевище ліміту повернення 429 з Retry-After головоломка. Повне машинно-прочитане контракт (все кінцеве місце, схема і помилка) живе в Контакты 3.0.3_ посилання.

Побудувати роз'єм

Перенести роз'єм в 5 кроків.

З'єднувач є папкою самоконтейнера.OpsIQВиявляє, що реєстр веде події, і ваш профільний код платформи ніколи не витікає в ядро.

1Сфало папка з connector.php широта AbstractConnector.
2Деклар actions.json і settings.json проявляється.
3Впровадити ідентичність, контекст та веб-провайдери.
4Підписатись на події, які ви хочете провести.
5Зареєструйтеся, ввімкніть його в адміністратора.
Тест до відправлення

пісочниця ключ і вебхоок тестер.

Кожна робоча простора виводить пісочницю: окремий об'ємний ключ, який і в той же часAPIповерхня без сенсорних даних виробництва. Використовуйте POST /v1/webhooks/test щоб вогонь підписаної проби доставки у кінцеву точку та підтвердити перевірку підпису до того, як буде жити. Самостійні установки запускають ідентичний шлях коду, без поведінкового дрейфу між хмарою і наперед.

Футболки для сендвіч-боксів Тестувальник вебхука Робота з короною Хмара і самоприхована парність
connector. php · php
клас Акумулятор Ø2 мм AbstractConnector { громадська функція ключ(): стр. { Повернутися ’Ком’; } // Вирішити, хто актор громадська функція айдентикиПровідники (): мастурбація { Повернутися [НОВИНКА AcmeIdentityProvider()]; } // Подача даних про живу в AI-зразку громадська функція Конфлікти (): мастурбація { Повернутися [НОВИНКА AcmeContextProvider()]; } // Реакція до OpsIQ події громадська функція абоненти(): мастурбація { Повернутися ['invoice. paid' => [НОВИНКА BillingMirror()]]; } // Отримати вхідні вебхуки з Acme громадська функція ручкаВебок(Vook)мастурбація $body): нудьгий { /* … */ } }
⁇ У ⁇

OpsIQпроти Інтеграція ДІЮ.

Що таке договірне, підписане, перевірена платформа дає вам змогу розкачати власні веб-доки та санітарні засоби, які ніколи не будуть.

МожливістьПочати свій власнийOpsIQ
HMAC-signed requests & webhooks (both ways) Hand-rolled
Idempotency keys + replay protection DIY
Automatic back-off retries with delivery IDs DIY queue
Action-contract registry (AI can't invent calls)
Confirmation policy before side-effects
100% audit-log coverage on actions Manual logging
Official PHP / Node / Python SDKs Write your own
OpenAPI 3.0.3 machine-readable contract Maybe
Sandbox keys + webhook tester Build a staging rig
Cloud & self-hosted parity (same code path) Вейджери
Connector pattern: platform code stays isolated
Юридична адреса

Питання розробника, відповіли.

Аут, підписи, SDKs, піскобоксинг і модель роз'єму: все, що ви запитати перед першим запитом.

API дзвінки автентичні з одним за розміром ключа Bearer: відправити Authorization: Bearer opq_…. OpsIQ перевіряє ключову сферу і роль актора перед тим, як пропустити. Webhooks окремі: кожен вебхок OpsIQ надсилає несе X-OpsIQ-Signature (HMAC-SHA256 сирого тіла) і спіраль HMAC-SHA256 сирого тіла) X-OpsIQ-Timestamp Для захисту відтворення, тому ви можете перевірити нас у поверненні, а також вхідні вебхоки, які ви надішлемо, перевірте однаково.
No. AI може запропонувати дії, які існують в вашому реєстрі дії-контракту. Не можна запускати дзвінок. Кожен договір проголошує поверхні, ролі та параметри, що дозволені, і будь-яка дія, зазначена в requires_confirmation поверхні карти попереднього перегляду до людини перед боковими роботами.
Рекомендація hash_hmac('sha256', $rawBody, $secret) (перетравлення шестигранної форми без префікса) і порівняння його до X-OpsIQ-Signature заголовок з постійною перевіркою (hash_equals). Кожна доставка також несе за собою часову допомогу, ключ і ідентифікатор доставки ви можете слідувати. PHP snippet на цій сторінці є вся перевірка.
Поставки, які не повертаються 200__ перераховуються з відступним відключенням, кожен з яких є ключем ідемпотенції, тому що повторна доставка ніколи не подвійна. Ви можете слідувати за кожну спробу, подавшиття ID в адмін або ваші журнали.
Офіційні SDK для PHP8.4+, Node.js18+ та Python3.10+ ручка підписання, речення, ключі відеоспостереження та типовані відповіді. Вони тонкі обгортки навколо поверхні REST, тому ви також можете створити власний клієнт з опублікованого OpenAPI3.0.3договір або викликAPIпрямо.
Так. Кожна робоча простора виводить пісочну коробку з власним об'ємним ключем, що і в той же часAPIповерхня без дотику даних про виробництво, плюс POST /v1/webhooks/test щоб вогонь підписаної проби доставки у кінцеву точку та підтвердити свою перевірку перед тим, як жити.
Так. Самостійні установки запускають ідентичний шлях коду (так само, як і реєстр, той же контракт OpenAPI), так що не існує поведінкового дрейфу між хмарою і на-перед.
Роз'єм є папкою самоконтейнера з одним класом PHP, що розширюється AbstractConnector, плюс actions.json і settings.json проявляється. Ви втілюєте identityProviders(), contextProviders(), registerActions(), subscribers() і handleWebhook(). OpsIQ auto-discovers it, проводів заходів і зберігає ваш сайт конкретним кодом, чисто відокремленим від ядра.