Developer platform · General API · webhooks · connectors

做起站台去有人工智能能用.

Call 2,420 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 鍵盤有相關文件嗎? OpenAPI 合同

範圍 Bearer 鍵盤2,420 contract actions開放程式界面 3.0.3 + PostmanHMAC 提供網路快取

範圍要求

有簽名的網游出局→ 200好

有活

2,420有名可取 API 動作

69三. 最低限限值

dry_run在執行前先驗證寫入合同

24 小時二元寫入已成功回放

所要的生命周期

有相關要求入住有簽名出道了

跳出一項動作去 /api/v1.php 用一個有範圍的 Bearer 關鍵 OpsIQ 订阅的典型事件通过 HMAC 签名交付队列离开,并具有可追溯尝试和有限重试。

HMAC- SHA256 網上呼喊 - 入站和出站 webhook 有效載荷在原始主體上簽名; API 呼叫用範圍認證 Bearer 關鍵

自動重試 失敗的送貨退回並重試帶著一個可以追蹤的送貨ID

重放安全寫入 有同樣的回應; 24 (一) 有1起索赔;

01 Bearer 請求 02 平接工作區 03 合同被作准 04 執行或干跑 05 已簽署的列

快起步

从按鍵到受管整合三步出行.

在您需要提供相關相關事由時, 使用最不優先的金鑰、發現所產生的合同、干燥寫入等功能取用網頁。

合同控制台有接通

執行干燥(_R)→有同一份合同被批准作文

有鑰匙取出

註冊並生成一個範圍 Bearer API 鍵opq_…) 在開發人員設定中，並且只給每個集成它所需要的曲面。

發現驗證( A)

讀取 meta.actions, meta.action 和 meta.scopes; 使用 dry_run 在行刑前作驗。

執行訂閱( P)

在您需要的相關事件上訂取您的端點。

如何將它們結合在一起

有一通接通器模式. 有五种清真原始.

任何平台特定的東西都會存在於連接器中。 OpsIQ 核心仍然是通用的, AI 仍然是可預測的, 而你的整合仍然是可審核的。

觸發器

告訴 OpsIQ 剛剛發生了什麼事。

从您平台上發出可控事件, 或是定義受管自訂事件。訂閱者會被收取此事件, 有已注册的優先權和送出規則。

事件参考

通用相關事件invoice.paid, ticket.created, subscription.cancelled, customer.signed_up 或是你自己的。 有名的貼名者人工智慧的大腦，自動化規則，鏡像連接器和你的網絡鏈接端點都會做出反應。 优先顺序有定義地發射出相關訊息后再回報出事。

02 行動合約

告訴 OpsIQ 人工智慧可以做什麼。

有相關相關的相關事務由相關人員所出:相關範圍、地點、讀取或寫取等類型、風險、確認政策、請求及回應相關方案、干跑相支援、一能和穩定的錯誤等。

動作相機

有人工智能出自于一項行動它只能要求去跑你已登記的活了. 確認政策有危險的動作會先被預覽卡所啟動再起副作用。 角色+表面取景每個動作都宣告了允許它運行的角色和表面。

已產生動作相關合同 -- 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.

重播保護有可追蹤的快取ID5-step back-off

網頁ook 參考

驗證網頁- 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 參考發件人加上節點和 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 HTTP (HTTP) :開啟API 3.0.3Postman 收藏整合助手

05 / 連接模式

就做一次就插入出事去

連接器是經由身份、 Auth、測試、動作、触发和回覆而產生或匯入的受管套件。它的通訊表顯示了能力的表面 OpsIQ 有被放出出相去相去取出相入相去等相去.

開啟六相建構器

有6个受指導相身份、 Auth、測試、動作、觸發和回應等都能解釋出套件產生的相關性。 由合同驱动8 profiles and 57 capability types declare the surfaces a package implements. 有放出在被當作已就緒的包裹出行前就先做安全、出行和相當相當的檢查了

从意向到安全行動

有通俗的英語有被審查的行動出局了有被審查了有被審查了的行動出局了有被審查了有被審查了的被審查了

OpsIQ 從來不會發明正確的呼叫。它會通過已註冊的合約，準備有效載荷，在行動需要時要求確認，並在執行時生成完整的審核行，所以一個能夠作就再也不能被你所不相信了

有合同 AI只建議你舉行出名的行動.

在副作用出發前再确认出相關事由. 有風險的動作先出出預覽卡。

完全的回憶。 有相關的相關報導也被收錄了。

看看動作圖表

4步驟意向→二. 审计

HMAC在執行前簽署

沒有出名的通訊仅限合同

已確認在副作用前先預覽

要求追蹤演員+合同+結果

參考

API 表面有一眼相看.

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

OpenAPI 3.0.3 參考

動作奧特( A)寫入安全性限制

寫入動作后 /api/v1.php 合同被审定

ACTION tickets.replytickets.write干法(_R) + 二相能性已配置/ 小時

ACTION security.reportsecurity.write干法(_R) + 二相能性已配置/ 小時

ACTION platform.routes.write管理確認 + 金鑰已配置/ 小時

讀取發現動作( A)相接相接的相接平面 :

ACTION meta.actions公開出品就只讀取已配置/ 小時

ACTION tickets.listtickets.read就只讀取已配置/ 小時

ACTION connectors.listconnectors.read就只讀取已配置/ 小時

PeopleOS 人力資源行動有被禁用 hr.* 合同 · hr.read / hr.write 範圍

ACTION hr.people.listhr.read就只讀取已配置/ 小時

ACTION hr.people.createhr.write干法(_R) + 二相能性已配置/ 小時

ACTION hr.org.treehr.read就只讀取已配置/ 小時

PeopleOS HR 不發出出 HR 有網游事件。在同樣 POST 表面取取用, 或是订阅已公佈的事件。完全參考: PeopleOS API 連接器和開發者參考的 PeopleOS 分區。此模組被封鎖了權限, 因此沒有鍵值 hr 有被拒絕了,不是被空的清單所取出. 什麼 PeopleOS 人力資源是.

速率限制被設定在每一個按時視窗上。反應顯示 X-RateLimit-Limit, X-RateLimit-Remaining 和 X-RateLimit-Reset; 已拒絕的要求回覆 429 有 Retry-After。使用 OpenAPI 3.0.3 合約或 Postman 收藏由同一個跑相登記所產生。

建立連接器

在內建置、測試和放出有六相相相.

从被管束的相關描述檔或自定相關相關的相機開始。在建立相關接器產生自成相關連相關套件前, 建構者先要先驗證相關分類相關。

1有身份相通. 有出自"相克"的地圖有出息有出行地道有出走地道道道通通通取出出行道通取取出行走地取出去取出相克道道入行地取取取回相克取出取出地道取出所取出之地道. Name, sult, profile and 宣告能克取取入地道外出.

2奧斯. API 鍵 Bearer基本 OAuth 2.0, HMAC 或自定義客戶端。

3有考驗了有考試了有想找的活人去取取取相關事由在容器前驗證已定界的接線設定值。

4有活了. 有地圖取出指名操作、參數、範圍和風險等相關資訊。

5有出息了. 有出自"相關事件"、"網上出道"等相關事由被公開投票和同步作業相關的相關報導。

6有回想相. 檢查所產生的合同并通過放行門.

在你發貨前測試

安全地驗證出出發口

使用 dry_run 在所支持的寫入動作上, 執行建構器的邊界接通測試, 在放行前檢查已產生的通貨單和合同。包驗驗證能力名稱、設定相關相關地點及需要的檔案; 背景工作者處理回應投票和出站出站等。

有干跑寫入有界接觸測試合同是否相符三相相干出行

開啟連接器編譯器網頁ook 參考

接通器. php 相接器

等級 AcmeConnector 延伸 AbstractConnector { 公用功能彈出( B) : 字符串 { 返回 (相克); } 公用功能名稱 () : 字符串 { 返回 "艾米" "Acme"; } 公用功能描述 () : 字符串 { 返回 "艾米·橋"; } // 从連接器通訊錄取名稱公用功能能力( C) : 陣列 { 返回 ["行動", 有相關的相關事由由我來做]; } 公用功能設定方案 (S): 陣列 { 返回 [["鑰匙" => "收起", "類型" => "口活"]]; } 公用功能驗證串接 (Connection ()陣列 $settings): 陣列 { 返回 ["成功" => 有正]; } 公用功能有手柄Webhook () 陣列 $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 已對應的分類( C)
04 actions.json 有名的操作
05 settings.json 接線器設定
06 connector_contract.json 有機可讀權限

07 signature.json one HMAC over a SHA-256 of every file above, plus an ed25519 proof of origin

能力矩陣 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 第二章 7

有兩個簽名有兩個問題

hmac-sha256 有相關文件的活口256 有快取回答案 有此項已自簽署后被修改一. ed25519 簽章回覆 有被簽署的相關文件嗎? Nabtech,可以用已捆綁的公用金鑰取出而沒有共享的密钥。編輯一字節并停止相配。

marketplace.json 有相關的簽名: 安裝者在簽名后寫出, 因此出版商永遠也不可能簽名。

02 · 工具/ mutation_ defense.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    }

沒錯一有相匹配的文字。 0 相匹配, 有2相匹配; 在相匹配相匹配前, 有相符合的證據已停止。

$ 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 彼此分析並達成共識
能力 在跑取時類相關的分類中已存在
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有相關的商業角色。檔案的存在是所謂的。它被宣布并消失于其停止時的售出設定中。沒有要加入的清單, 沒有人可以要求。

標準角色 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有被取出相關資訊的相關地點。

在您輸入時建構者會驗證這些, 而驗證者會認證已發出相關的套件。兩者都稱取同樣的函數, 因此他們不能相異。

⚖️ How it compares

OpsIQ 對a DIY整合.

有合同的有簽名有被審查的平台能讓你得到自己自動出發的網絡和人工智能接通管道永遠不會被打動了

能力	自己滾	OpsIQ
範圍 Bearer API + HMAC 簽名的 webhook	有手卷	✓
Dry-run 寫出 + 24- 已成功回放	DIY : (正末)	✓
1米→5米→30米→ 2h → 12h重試	DIY 排入	✓
(AI不能發起通訊)	—	✓
在副作用前先确认政策	—	✓
有穩定的錯誤信封 + 要求的ID	手動下載	✓
有直接 HTTP + 產生的客戶端選項	有自已的寫作相去相去而去	✓
開啟API 3.0.3 有机可读合同	有可能	✓
六相建構器 + 包放出門	建立工具鏈	✓
工作位基礎和活地限制	有變相	✓
接通器模式: 平台代碼被相隔	—	✓

有花有花相干

有開發者問題, 有接通了.

在第一次出品前作證合同相關再審查客戶端產生安全測試和接通器模型

一般 API 有電話接通了 Authorization: Bearer opq_…。金鑰可以被無限制地、被限制地或只被取用,可以帶入最不偏重的範圍,可以遵守時限并被固定到工作區去。 Webhook signation is explain: external results carry X-OpsIQ-Signature, X-OpsIQ-Timestamp, X-OpsIQ-Event 和 X-OpsIQ-Delivery.

第二部分有有有相關的有有相關相關有有同有相通有同相通相通有同相關的相關通訊相通通通訊通訊.

重算 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 參考發送人和節點/ Python 集成客戶端相關相關支援事件及網頁行走;相關人不是相關分類的相關事由API 合同。

使用 dry_run 在相關相關接器被做成已就緒前取出相關口門并放出相通口。

安裝放出會產生它的 API 有相關通訊器的通訊錄取出相關的通通訊管。您所接通的通報有同樣的通傳管用。URL 因此相對於已安裝放出而不必從雲中去想出相關行為。

有接通器是被管束的相接相接器 settings.json,可選取 actions.json,生成的能力相接合同、文件和可選的企業延伸。六相建構器會組成;通訊錄會發現;相符合并放出出出門口以驗證它。

做起站台去 有人工智能能用.

有相關要求入住 有簽名出道了

从按鍵到受管整合 三步出行.