開發者平台 : REST : : sDKs :
做起站台去 有人工智能能用.
OpsIQ 公開了一個清潔的REST API、由 HMAC 簽署的 webhook、一個動作合約注冊表和準備發送的 SDK。 定義哪些事件會從你的系統中觸發、哪些動作允許 AI 執行、以及哪些資料是安全可讀的。 OpsIQ 為你處理簽名、重試、審核日志和確認流程。
HMAC-SHA256 兩種方式PHP 節點 ─ Python SDKsOpenAPI 3.0.3 合約100% 審計覆蓋面
有簽署的請求已於
已簽名的網絡呼出_200罷
有活
3正式 SDK: PHP、 節點、 Python
哈佛商學院莎麗...256每一份申請都簽名
40+要訂閱的通用事件
100%(一) 审计 -- -- 日志:
所要的生命周期
HMAC- SHA256 網上呼喊 有出入境的活口被活口活口所簽署;API有可標準的相關鍵的叫法被驗證了 。
自動重試 失敗的送貨退回並重試 帶著一個可以追蹤的送貨ID
相關鍵 有再生相保 所以再生相保的快活 就不會有再生相保了
有需要就去接他 有名的網路通了.
回到上一頁OpsIQ API用你的範圍內的持有者密鑰 。OpsIQ檢查範圍和角色，執行合約動作，寫入一個審核行，然後發射一個由 HMAC 簽署的 webhook 回到你的終端。 每個跳躍都經過身份驗證，同源，並在失敗時重試。
01 有簽署的請求
02 檢查 HMAC
03 執行合同
04 寫入審查行
05 有簽名的網頁
快起步
從零開始到實時整合 有四步了.
生成一個密鑰, 啓動您的第一個事件, 訂閱一個網頁, 註冊一個動作。 您可以在觸摸生產數據之前, 將整個循環對接沙盒 。
沙盒控制台有接通
升出沙盒 → 生產 ， 同樣的代碼
有鑰匙取出
註冊並生成一個範圍的持有人 API 密鑰 (opq_…) 在開發人員設定中，並且只給每個集成它所需要的曲面。
相關用戶( P)
有簽名后 events/fire (或使用 SDK ), 然後指向任何 URL 事件, 簽名, 提供一個交付 ID 和回退重試。
登入動作
有角色檢查、確認政策及全面審查線索等。
如何將它們結合在一起
有一通接通器模式. 有五种清真原始.
任何平台特定的東西都會存在於連接器中。 OpsIQ 核心仍然是通用的, AI 仍然是可預測的, 而你的整合仍然是可審核的。
01
通用相關事件
invoice.paid, ticket.created, subscription.cancelled, customer.signed_up 或是你自己的 。
有名的貼名者人工智慧的大腦 ， 自動化規則 ， 鏡像連接器和你的網絡鏈接端點都會做出反應 。
优先顺序有定義地發射出相關訊息后再回報出事。
有人工智能出自于一項行動它只能要求去跑你已登記的活了.
確認政策有危險的動作會先被預覽卡所啟動再起副作用 。
角色+表面取景每個動作都宣告了允許它運行的角色和表面 。
行動契約 —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郵政JSON在生體上與HMAC-SHA256簽署有效載荷——用幾行來驗證.
重播保護有可追蹤的快取ID后退回覆
網頁ook 參考
驗證網頁- 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軟體開發工具包
有您已用入的語言的下載客戶端 。
三個官方的SDK可以處理身份驗證、簽名、重試、同位密鑰和輸入式應答。 或者不需要框架 - 每個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",
})
有五把被子
identityProviders(), contextProviders(), registerActions(), subscribers(), handleWebhook().
有相通性地actions.json 和 settings.json 宣佈合約和配置
自動被發現放下資料夾,簽名, 在管理中開啟 。
从意向到安全行動
有通俗的英語 有被審查的行動出局了 有被審查了 有被審查了的行動出局了 有被審查了 有被審查了的被審查了
OpsIQ從來不會發明正確的呼叫。 它會通過已註冊的合約，準備有效載荷，在行動需要時要求確認，並在執行時生成完整的審核行，所以一個能夠 作 就再也不能被你所不相信了
有合同 AI只建議你舉行出名的行動.
在副作用出發前再确认出相關事由. 有風險的動作先出出預覽卡 。
完全的回憶 。 有相關的相關報導也被收錄了。
4步驟意向 = 审计
哈佛商學院在執行前簽署
沒有出名的通訊仅限合同
已確認在副作用前先預覽
100%經過審計提示 + 回應 + 結果
參考
OpenAPI 3.0.3 參考
API表面 有一眼相看.
每個核心端點,其認證,一能和每鍵率限制。完整的機器可讀合同都生活在 OpenAPI 中3.0.3參考文獻。
收尾點奧特( A)第 三 章 有 缺 缺利率限制
寫入有號副作用表面
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 完整的機器可讀合約(每個端點、架構和錯誤)都存放在 OpenAPI 3.0.3 參考.
建立連接器
有接通器被運入 有五步了.
連接器是個自我包含的文件夾。 OpsIQ 會發現它, 註冊表會傳遞事件, 而你的平台特定代碼永遠不會泄漏到內核。
1有相關資料夾的手冊
connector.php 延伸 AbstractConnector.2宣告
actions.json 和 settings.json 名單3實取身份、上下文和提供網頁的提供者。
4就你所關心的事件訂閱吧
5有簽名 就放入去 就讓出管事去取取出
在你發貨前測試
沙盒鑰匙和網絡測試器
每個工作空間都暴露出一個沙盒:一個單獨的瞄准鏡鍵,擊中相同API不觸摸生產數據。使用 POST /v1/webhooks/test 在您端點發出簽名的樣本并確認您在啟用前的簽名驗證。自訂安裝會跑出同樣的密碼路由, 在相關地點上云和相關地點之間沒有行為漂移 。
沙盒金鑰
Webhook 測試器
有線相通的工作
云自主機等同( S)
等級 相干接線器 延伸 AbstractConnector
{
公用功能 金鑰 (): 字符串 { 返回 (相克); }
/ 決定出演者是誰 /
公用功能 提供者 (): 陣列 {
返回 [已新增 AcmeIdentityProvider()];
}
// 以活相接資料入入 AI 便捷
公用功能 提供者 (): 陣列 {
返回 [已新增 AcmeContextProvider()];
}
/ / 反應到OpsIQ事件
公用功能 訂閱者 (): 陣列 {
返回 [有收費的相片 => [已新增 BillingMirror()]];
}
// 从 Acme 接收入內的網上呼號
公用功能 有手柄Webhook ()陣列 $body): 空 { /* … */ }
}
有相對之分
OpsIQ對a DIY整合.
有合同的 有簽名 有被審查的平台能讓你得到 自己自動出發的網絡和人工智能接通管道 永遠不會被打動了
| 能力 | 自己滾 | 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 | — | ✓ |
有花有花相干
有開發者問題, 有接通了.
認證,簽名,SDK,沙盒和連接器模型:在第一次請求之前,你會問的一切.
API 呼叫使用單一範圍認證
Authorization: Bearer opq_…. OpsIQ在任何事件運行之前檢查鍵的範圍和演員的角色。OpsIQ發送 、 傳遞 X-OpsIQ-Signature 原始文件的密碼 X-OpsIQ-Timestamp 有回放相關保護 因此您可以回復回復回復回回覆回覆了我們 而您所發出入住的網上呼號被以同樣的方式被驗證出不是的，人工智慧只能建議在你的動作合約寄存器中存在的動作，它不能創造一個呼叫。每個合約都宣布允許的曲面、角色和參數，以及任何標記的動作
requires_confirmation 在副作用跑出前向人放出預覽卡。重算
hash_hmac('sha256', $rawBody, $secret) (一六分之一而無前缀)并作比對 X-OpsIQ-Signature 有常時檢查的頭( C)hash_equals。 每一份送出都包含有時刻戳、 一等分量金鑰和可以被追蹤的送出ID。 此頁面上所顯示的 PHP 片段是整份檢查 。送貨不還的200重審時, 每一個都帶有相同的等效鍵, 所以重審後發送不會重復。 您可以在管理員或日誌中跟蹤每次發送ID的嘗試 。
官方的 PHP 8.4+、Node. js 18+ 和 Python 3.10+ SDK 可以處理簽名、重試、同位鍵和輸入式應答。 它們是 REST 表面的薄包裝，因此你可以從已發布的 OpenAPI 3.0.3 合約生成自己的客戶端或直接調用 API。
是的 ， 每個工作空間都會有一個沙盒 ， 有它自己的範圍鍵 ，API表面不會碰到生產數據 ，
POST /v1/webhooks/test 在您端口發出簽名的樣本 在啟用前確認您是否確認了您的身份是的,自裝安裝運行相同的代碼路徑(相同的簽名,相同的連接器註冊,相同的OpenAPI合同),因此雲和上-prem之間沒有行為漂移.
連接器是自成一體的資料夾, 有一款相關的 PHP 等級相延長
AbstractConnector外加 actions.json 和 settings.json 你實施 identityProviders(), contextProviders(), registerActions(), subscribers() 和 handleWebhook()OpsIQ 自動發現它, 連接事件, 並且讓你的平台特定代碼與核心清楚分離。