Платформа розробника · Загальні API · webhooks · роз'єми

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

Call 2,418 named operations through one contract-generated API, with least-privilege scopes, workspace pinning, dry-run validation and replay-safe writes. Subscribe to canonical events through HMAC-signed background webhooks, or build a governed package in the six-stage Connector Builder.

Отримай відповідь на новини API Читати документ Договір публічного працевлаштування

Скопіювати ключі Bearer2,418 contract actionsЕлектронний ресурс 3.0.3 + PostmanHMAC вебхоок доставка

Заявка на копчену заяву

Підпишіться на розсилку → 200 ЦЕНА ЗА ЧАС

ЦЕНА ЗА ЧАС:

2,418Ім'я користувача API дії

69Мінімально-прив’язні обсяги

dry_runвалідувати договори на написання до виконання

24 годиниуспішний реплей-візитний повтор

Термін служби запиту

Заявка на копію. Вивіска.

ПОСТ дії /api/v1.php з за розміром ключа Bearer. OpsIQ шпильками робочого простору, вносить договір дій та дозволи, потім виконує або висушує його. Підписані канонічні події залишають через чергу доставки HMAC з відмітними спробами і обмеженими реченнями.

Веб-сайт HMAC-SHA256 - вхідні та вихідні навантаження на вебху підписуються над сирим тілом; API дзвінки автентичні з за розміром ключа Bearer.

Автоматичні рети - не вдалося виставити відправлення і птиця, з ідентифікатором доставки ви можете слідувати.

Релей-безпечні записи - успішний idempotent записує повернення одного відгуку для 24 годин; одночасні дублікати діляться однією заявою.

01 Запит на в'язниці 02 шпильцевтичний робочий простір 03 вакантний договір 04 виконання або сухий 05 черга підписана подія

Швидкий запуск

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

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

Консоль контрактуЗ'єднання

Виконуватисухих_run → затверджений запис, той же контракт

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

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

Знайти та перевірити

Читати далі meta.actions, meta.action і meta.scopes; використання dry_run написати до виконання.

Виконувати та підписатися

Додати ключ idempotency для запису, після чого підписайте кінцеву точку на канонічні події.

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

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

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

Тригери

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

Ви можете дізнатися про події, які ви хочете зробити замовлення.

Посилання на захід

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

02 / Договір про дії

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

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

Дія schema

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

генерований договір про акцію · JSON_

{
  "action": "tickets.reply",
  "kind": "write",
  "scopes": ["tickets.write", "admin"],
  "feature": "ticket_system",
  "risk": "medium",
  "confirmation": "recommended",
  "idempotency": "supported",
  "dry_run": true,
  "request": { "type": "object" },
  "response": { "required": ["success"] }
}

03 / Підписано вебок

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

Subscribe any URL to any of the 52 deliverable events. OpsIQ POSTs the JSON payload signed with HMAC-SHA256 over the scheme version, the timestamp, the delivery ID and the body together, not the body alone, so yesterday's delivery cannot be replayed at you today.

Захист релейІдентифікатор доставки5-step back-off

Посилання на веб-сайт

php - Українська

$raw = file_get_contents('php://input');
$sig = $_SERVER['HTTP_X_OPSIQ_SIGNATURE'] ?? '';   // "v2=<hex>"
$ts  = (int)($_SERVER['HTTP_X_OPSIQ_TIMESTAMP'] ?? 0);
$id  = (int)($_SERVER['HTTP_X_OPSIQ_DELIVERY'] ?? 0);

if (abs(time() - $ts) > 300) http_response_code(401);   // replay window
[$ver, $hex] = array_pad(explode('=', $sig, 2), 2, '');  // split the prefix

$signed   = $ver . '.' . $ts . '.' . $id . '.' . $raw;   // NOT the body alone
$expected = hash_hmac('sha256', $signed, $secret);
if (!hash_equals($expected, $hex)) http_response_code(401);

$event = json_decode($raw, true);   // $id is stable across retries

04 / СДК

Використовуйте прямий HTTP або створити клієнт, який ви віддаєте перевагу.

Повне Генеральне API Опубліковано як OpenAPI 3.0.3 і Postman. PHP посилання відправників плюс Node і Python інтеграція клієнтів охоплює підписаний захід і Webhook потоків; будь-який стек може викликати той же самий JSON поверхня дії безпосередньо.

Приклади клієнтів

const response = await fetch(`${base}/api/v1.php`, {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.OPSIQ_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    action: "tickets.reply",
    dry_run: true,
    idempotency_key: crypto.randomUUID(),
    body: "Thanks. We are checking this now."
  })
});

$payload = json_encode([
  'action' => 'tickets.reply',
  'dry_run' => true,
  'idempotency_key' => bin2hex(random_bytes(16)),
  'body' => 'Thanks - we are checking this now.',
]);

$ch = curl_init($base . '/api/v1.php');
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_POSTFIELDS => $payload,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('OPSIQ_KEY'),
    'Content-Type: application/json',
  ],
]);

response = requests.post(
    f"{base}/api/v1.php",
    headers={
        "Authorization": f"Bearer {os.environ['OPSIQ_KEY']}",
        "Content-Type": "application/json",
    },
    json={
        "action": "tickets.reply",
        "dry_run": True,
        "idempotency_key": str(uuid.uuid4()),
        "body": "Thanks - we are checking this now.",
    },
)

Прізвище JSON ХмариЕлектронний ресурс 3.0.3Колекція плакатівІнтегровані та інтеграційні

05 / Роз'єм шаблон

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

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

Відкрийте шестиступінчастий конструктор

Шість керованих етапівІдентифікатор, авт, тест, дії, тригери та огляд зберегти процес створення пакету. Договірна робота8 profiles and 57 capability types declare the surfaces a package implements. ВиданийКонтроль якості, перевірки та відповідності до пакету.

Від неприпустимого до безпечного дій

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

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

Договірне перевезення. Зареєстровані дії AI пропонують тільки ті, які ви зареєстрували.

Підтвердіть перед побічними ефектами. Ризикові дії на поверхню попереднього перегляду картки першим.

Сума. Кожен запит, відповідь та результат дій, який захопив історію AI.

Дивитися дію schema

4 крокиintent → аудит

HMAC_Підписатися на виконання

Не придумайте дзвінкиРеєструаційний рахунок тільки

Підтвердитипопередній перегляд перед побічними ефектами

Запитати слідактор + договір + результат

Посилання

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

One JSON POST surface exposes 2,418 named actions. Each generated contract declares auth scopes, read/write kind, risk, confirmation, request schema, dry-run, idempotency and stable errors.

Контакты 3.0.3

ДіяАутиБезпекаЛІТЕРА

Написати діїПІСЛЯ /api/v1.php · договір, що діє

ACTION tickets.replytickets.writeсухе_рун + idempotencyКонфігурація / час

ACTION security.reportsecurity.writeсухе_рун + idempotencyКонфігурація / час

ACTION platform.routes.writeадміністраторПідтвердження + ключКонфігурація / час

Читання та відкриття дійНатура POST · стабільні конверти

ACTION meta.actionsПублічне відкриттяПрочитатиКонфігурація / час

ACTION tickets.listtickets.readПрочитатиКонфігурація / час

ACTION connectors.listconnectors.readПрочитатиКонфігурація / час

Діяльність HR-спільнотиПриват hr.* договори · hr.read / hr.write ОБСЛУГОВУВАННЯ

ACTION hr.people.listhr.readПрочитатиКонфігурація / час

ACTION hr.people.createhr.writeсухе_рун + idempotencyКонфігурація / час

ACTION hr.org.treehr.readПрочитатиКонфігурація / час

Люди не відправляється з веб-події HR. Зробляйте його через одну і ту ж поверхню POST або підписайте на події інші модулі опублікувати. Універсальні інженерні рішення API та роз'єми і PeopleOS section of the developer reference. Модуль є обов'язковим словом, тому ключ без hr не порожня. Що таке HR-спільнота.

Обмеження ставок на час на вікно. Відповіді викладаються X-RateLimit-Limit, X-RateLimit-Remaining і X-RateLimit-Reset; відмова від запиту 429 з Retry-After. Використовуйте КРОК 3.0.3 договірна або Колекція плакатів з тих же реєстрів часу.

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

Побудувати, перевірити і звільнити шість етапів.

Почати з керованого профілю або визначити договір самостійно. Будівельник перевіряє кожен етап, перш ніж він виробляє саморозташований пакет роз'єму.

1Ідентифікатор. Назва, стропи, профіль і заявлені можливості поверхонь.

2Аут. API ключ, ведмедик, Basic, OAuth 2.0, HMAC або індивідуальний клієнт.

3Тестування. Встановіть налаштування з'єднання, що обмежена перед пакуванням.

4Дії. Карта названих операцій, параметрів, сфер і ризику.

5Тригери. У разі виникнення проблем, що виникають у зв’язку з цим, вебоками, опитуваннями та симплінною поведінкою.

6Огляд. Оглянути створений контракт і пройти випуск воріт.

Тест до відправлення

Дійсно, потім пропускають вивільнення воріт.

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

Схил-рун пишу Тест з'єднання пов'язаний Конформанс договору Доставка бронзи

Відкрити конструктор роз'ємів Посилання на веб-сайт

connector. php · php

клас AcmeConnector Ø2 мм AbstractConnector { громадська функція болгарка(): стр. { Повернутися ’Ком’; } громадська функція Ім'я(): стр. { Повернутися ’Акме'; } громадська функція опис(): стр. { Повернутися 'Акме міст'; } // Використання імен з ConnectorContract громадська функція можливості(): мастурбація { Повернутися [«Дія», ’Сучасний сайт]; } громадська функція settingsSchema(): мастурбація { Повернутися [[’Киев'я => 'Токен', 'тип' => "Післямова"]]; } громадська функція ТестПідключення(мастурбація $settings): мастурбація { Повернутися [’Наступний' => Правдива]; } громадська функція ручкаВебок(Vook) мастурбація $payload, мастурбація $headers, мастурбація $settings ): мастурбація { Повернутися [’Наступний' => Правдива]; } }

01 · Connector contract 2.4

Пакет не може вимагати можливості код не має.

OpsIQ\Connectors\ConnectorContract є органом. Відкриття робочого часу, будівельник, перших сторін пакетів, конформанс, Генеральний директор API і кожен довідник прочитав, що один реєстр. Розгорніть можливість та три файли, які повинні погоджуватися з кожним наступними перед OpsIQ Маршрути одного ряду до вас.

ФІГ. 01роз'ємний пакет, деталі проявляються scale 1:1 · contract 2.4

01 connector.php режим-клас
02 IdentityProvider.php стабільний зовнішній ключ
03 SalesIngest.php конденсаторСалес()
04 actions.json названі операції
05 settings.json налаштування оператора
06 connector_contract.json машинно-прочитане повноваження

07 signature.json один HMAC над СХА-256 з кожного файлу вище, плюс ed25519 доказ походження

Матриця ємності all 57, as registered

маніфестація тригери вебка journey_events КОМПЛЕКТИ guest_lookup айдентика sales sales_reconciliation августка payments Торгівля inbound_ticket outbound_reply ticket_merge sync_users sync_departments sync_orders sync_products sync_projects customer_import security_events security_native_block survey reply_feedback promo_audience promo_feed email_mailbox inbound_email outbound_email mailbox ai_tickets ai_reply ai_brain_aware native_api platform_bridge native_data кішка block_registry inbound_comment outbound_note outbound_notification oauth reviews локальна кішка site_intelligence аналітика comms admin_assets enterprise_hooks durable_queue ticket_mirror attachment_bridge database_migrations scheduled_workers conflict_resolution

генерація 30 декларативний 20 Ø2 мм 7

Два підписи, два питання.

hmac-sha256 над детермінатичним навантаженням на файл SHA-256 має відповіді було змінено з моменту підписання. А. ed25519 Відповіді на підпис підписала Nabtech_, перевірте з вказаним публічним ключем і не поділився секретом. Редагуйте одну опуклість і перші зупинки матчу.

marketplace.json За винятком підпису, а інсталятор пише його після підписання, тому видавець ніколи не підписав його.

02 · інструменти/мутація_proof. php

Не вдалося непровен.

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

охоронець · читати роль необхідно відмовитися від руйнівної роботи CH1 verify_commerce_contracts

src/Connectors/CommerceRoleMapVerifier.php МУТАЦІЙ

211    /* A read role must never reach a destructive operation. */
212-   if ($isRead && $isDestructive) {
212+   if (false) {
213        $errors[] = "read role '{$role}' points at a destructive op";
214        return false;
215    }

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

$ php tools/mutation_proof.php --spec=proofs.json

1[ ok ]hash    sha256 4f2a9c1e…
          remember the file exactly as it is
2[ ok ]control exit 0
          green BEFORE anything is touched
3[ ok ]mutate  1 match, lint ok
          one replacement, then php -l the mutant
4[RED ]prove   exit 1
          and "read role destructive" IS in the failures
5[ ok ]restore bytes written
          the original, not a regenerated copy
6[ ok ]verify  sha256 matches
          and the check is green again
 ══ PROVEN. file restored, hash matched, 1 proof run, 0 failed.

Не вдалося доказувати нема записано. Відповідаючи, що перевірка не була доказом того, що охоронна робота.

Мутація ніколи не застосовується.

У тексті пошуку не збігався, файл був доручений, номер пройшов і записаний доказ зелений під старою кодом про код, який ніколи не був старий. Спійманий, що вимагає точно одного текстового матчу і порівняння файлів має бути або сторона.

Мутація зламала щось інше.

У номері вийшов червоний, тому що файл припинив парсінг або загинув чобіт, і доказ записав червоний, який нічого не мав захвата. Спійманий лляним рухом і вимагає від Ім'я Тест серед збоїв.

Не можна залишити мутант на диску.

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

03 · Конформанс

Сертифікація - це команда з вихідним кодом.

Not a review queue where somebody reads your code and forms an opinion. Run the same suites we run, on your own machine, before you submit. 8 published JSON Schemas under doc/contracts/schemas/ налаштування кришки, дії, Будівельник специфікації, подорожі та комерція подій картування, рецепти робочого процесу, роз'ємні контракти і реліз проявляються.

manifests згодні один одному
можливості існує на рівні runtime
interfaces втілення декларованого
files кожен необхідний файл
маніфестація матч дій проявляється
destructive підтвердження
айдентика стабільний зовнішній ключ, не електронної пошти
Респлей повторне оновлення, ніколи не дублікати
Підприємство декларація, що відповідає розширенню
верстка КУРСИ, ДЕВЕЛОП, ЧАНГЕЛОГ
сперма JSON діє

Випадковий 0 acme: conformant against contract 2.4 Не вдається номеру, який знаходиться на місці реєстрації і файлу. Ви його закріплюєте, не з нами.

$ php tools/test_connector_conformance_all.php --connector=acme $ php tools/test_connector_json_schemas.php $ php tools/verify_commerce_contracts.php $ php tools/release_gate_connectors.php --require-signatures

Вказуйте перший в реальному невиробничому рахунку --live-settings=/secure/test-acme.json. Хоча ви все ще ітерує, закрутіть останні --unsigned-ok: лікує відсутній підпис, як очікуваний попередження, а не претендувати його штраф.

04 · Торгівля_роли.json

Декларування, що ви можете продати не є реєстрацією.

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

канонічна роль commerce_roles.json Ваше ім'я

ОБЛАДНАННЯ

канонічний ЦЕНА ЗА ЧАС: роль наклеєний до загальної запису. Узгоджується з'єднання: зберігання іменника, що знаходиться в місці мутації, незалежно від умовного положення. Написання бізнес-ряду безпосередньо пропускає ціноутворення платформи, блокування доступності та підтвердження пошти, і виробляє замовлення власної системи лише половина вірить. Ні recovery або, так що час не буде відтворюватися.

commerce_roles.jsonВАРІАНТИ

{
  "commerce": {
    "roles": {
      "catalog_search": { "operation": "acme_search_products", "transport": "http" },
      "order_get":      { "operation": "acme_get_order",       "transport": "http" },
      "order_create":   { "operation": "acme_create_order",    "transport": "http",
                         "recovery":  "acme_get_order" }
    }
  }
}

Його власний файл з метою: connector_contract.json генерується та породжує її набори additionalProperties:false, так що вручну блок не буде валідації, а потім перезаписувати на наступний курс генератора.

Закрита словник

Роль не в CommerceRole не існує. OpsIQ ніколи не заважає одне з назв операції, адже ім'я не обіцяється.

Ваша дія

В роботі необхідно з'явитися операції actions.json. Визначте, що не існує обіцянок замовника щось, яке потім виробляє нічого.

Написання про відновлення

Найнебезпечніший час роботи — це один після того, як платформа вже виконана. Не дивлячись на те, що ми пишумо землю, то лише варіанти торкаються сліпими або втрачають порядок.

Платіжні ролі засвідчуються

Яка роль у розрахунків, а також заявляє payment_profile з Природні, webhook_verify за допомогою власної схеми провайдера, event_map. Непристойна середовище є те, як тест-mode провайдер приймає оплату в режимі реального часу.

Конструктор перевіряє ці функції, як і ви типу, так і від'єднувача, що діє на відправлення пакету. Обидва функції називають однаковими, тому вони не можуть бути незгодні.

⚖️Як порівнювати

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

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

Можливість	Почати свій власний	OpsIQ_
Підшипник API + HMAC-призначений вебок	Руководство	✓
Схил-біг записує + 24-годинний успішний релей	ДІЄ	✓
1m → 5m → 30m → 2h → 12h retries	ЧАСТИНА ДІЯЛЬНОСТІ	✓
Реєстри контрактів (AI не може запускати дзвінки)	—	✓
Політика підтвердження перед побічними ефектами	—	✓
Конверт для помилок + ідентифікатори запиту	Керівництво залога	✓
Прямий HTTP + сформовані параметри клієнта	Написати своє	✓
КРОК 3.0.3 машинно-прочитаний контракт	Мапа	✓
Шість-стажів будівельників + випуск пакета воріт	Побудувати інструмент	✓
Робочі місця-шпильовані ключі та часові ліміти	Вейджери	✓
Роз'єм шаблону: код платформи залишається ізольованим	—	✓

Юридична адреса

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

Ауттентифікація, контракти, речення, виробництво клієнтів, безпечне тестування та модель роз'єму, перед першим виробничим запитом.

Універсальні API дзвінки Authorization: Bearer opq_…. Ключі можуть бути обмеженими, обмеженими або зчитуваннями-тільки, перевозити принаймні припливні ділянки, обібрати погодинну ліміт і можна закріпити до робочого простору. Вхід Webhook окремий: вихідні поставки X-OpsIQ-Signature, X-OpsIQ-Timestamp, X-OpsIQ-Event і X-OpsIQ-Delivery.

No. AI може запропонувати тільки іменні операції в реєстрі дій. Кожен згенерований контракт визначає сферу, поля запиту, політику ризику та підтвердження; операції, політика яких вимагає підтвердження поверхні людини перед виконанням.

Рекомендація hash_hmac('sha256', $rawBody, $secret) і порівняти його з шестигранним травленням X-OpsIQ-Signature за допомогою hash_equals. Дійсно X-OpsIQ-Timestamp у вікні відтворення та використання X-OpsIQ-Delivery як слідчий ідентифікатор доставки.

Несучасна спроба вводить черги доставки фону. OpsIQ ретрі на 1- хвилини, 5- хвилини, 30- хвилини, 2- час і 12-часні сходи при зберіганні ідентифікатора та історії спроб доставки для діагностики.

Дзвоните до JSON прямо, імпорт генерованої колекції Postman або створення клієнта від OpenAPI 3.0.3. PHP посилання відправників та клієнтів, які підтримують події та витрати вебок; вони помічники, а не окремі API контракти.

Використання dry_run на дії, які генерували контракт, запустіть тест з'єднання «Роз'єм», перевіривши його сформовані файли та передають роз'єму пакету і випускають ворота до обробки роз'єднувача.

Встановлений реліз генерує його API та роз'єм контрактів з власних реєстрів runtime. Ваше розгортання має свою громадськість URL, секрети, зберігання і cron/workers, тому поведінка повинна бути перевірена проти встановленого релізу, а не передбачається з хмарного середовища.

Роз'єм регулюється пакетом, що містить адаптер, settings.json, необов'язково actions.json, створене можливість контракту, документації та додаткового розширення підприємства. шестиступеневий конструктор збирає його; реєстр відкриває його; конформаційно-випускні ворота, які втілюють її.