開発者プラットフォーム・REST・webhooks・SDK
プラットフォームを作る 人工知能の運用性
OpsIQ清潔なRESTを露出API、HMAC署名のWebhook、アクションコントラクトレジストリ、および準備完了したSDK。システムから発生したイベント、AIが実行できる操作、およびどのデータが安全であるかを定義します。OpsIQ署名、検索、監査ログ、確認フローを処理します。
HMAC-SHA256 両方の方法PHP・Node・Python SDKOpenAPI 3.0.3_ 契約100% 監査のカバレッジ
リクエストで署名
署名されたwebhook アウト → 200 OK
ライブ
3公式 SDK: PHP、Node、Python
ムアックSHA-256 はリクエストごとに署名しました。
40+ユニバーサルイベントを購読する
100%アクションに関する監査ログのカバレッジ
ライフサイクルの要求
HMAC-SHA256 Webhooksの使い方 - オーバーインバウンドとアウトバウンドのWebhookペイロードは、生体の上に署名されます。 API_ はスコープ付きベアラーキーで認証を呼び出します。
自動レトリー - 発送を返し、再配達に失敗しました。配送IDで追跡できます。
出没鍵 - 設計によって再再生安全、従って引き込み配達は決して二重行為をしません。
リクエスト サインアップ
あなたにポストするOpsIQ APIスコープ付きベアラーキーを使って。OpsIQスコープとロールを確認し、契約したアクションを実行し、監査行を書きます。その後、エンドポイントに戻ったHMAC署名のWebhookを発射します。すべてのホップは認証され、不備があり、故障時に取得されます。
01 署名された要求
02 HMAC を検証
03 契約の実行
04 監査行を書く
05 署名された webhook
クイックスタート
ゼロからライブインテグレーションまで 4つのステップ。
鍵を生成し、最初のイベントを始動させ、webhookを購読し、アクションを登録します。プロダクションデータに触れる前に、サンドボックス全体でループを実行できます。
Sandboxコンソール接続先
プロモーションSandbox → 生産、同じコード
鍵をつけよう
スコープ付きベアラーの登録と生成 API キー ()opq_…) 開発者の設定で、各統合が必要な表面だけに与えます。
火災と加入
署名したPOST events/fire (または使用)SDK)、それからポイントを置いて下さいURL任意のイベントで、署名し、配送IDとバックオフのレトリーで。
アクションを登録する
署名されたアクション契約を宣言し、AIは安全に操作を実行できるように、ロールチェック、確認ポリシー、および完全な監査証跡を操作できます。
一緒に合う方法
コネクターのパターン1つ。 きれいなプリミティブ5本
プラットフォーム固有のものは、コネクタに住んでいます。 OpsIQ コアは汎用性を維持し、AIは予測可能であり、統合は監査可能になります。
01
トリガー
OpsIQ_ は何が起こったのかを教えてください。
プラットフォームから、または独自のカスタムイベント名で普遍的なイベントを始動させます。すべての加入者は、優先的に注文してリアルタイムに反応します。
イベントの参照
ユニバーサル+カスタムイベント
invoice.paid, ticket.created, subscription.cancelled, customer.signed_up または、あなた自身の。
ファンアウト加入者AI の脳、オートメーションの規則、ミラーのコネクターおよびあなたの webhook はすべての原子炉を終点見ます。
優先注文決定的なディスパッチは、警告が火を前に書き込むようにミラーをします。
02/ アクション契約
お問い合わせOpsIQAIができること。
アクションコントラクトは、署名された JSON 宣言です。アクションが実行できるもの、それを実行するパラメータ、確認が必要かどうか、呼び出しのエンドポイント。
アクションスキーマ
AIはアクションを発明できません登録したものを全て実行するように依頼できます。
確認ポリシーリスクアクションは、副作用が発生した前にプレビューカードをトリガーします。
ロール+表面にgatingアクションは、実行する権限を持つロールと表面を宣言します。
アクションコントラクト - 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_/ 署名されたwebhooks
暗号化証拠でイベントをスタックにプッシュする。
任意のイベントに URL_ を購読します。 OpsIQ_ は、生体の上に HMAC-SHA256 と署名した JSON_ ペイロードをPOST - 数行で確認します。
再生の保護トレーサブルデリバリーIDバックオフのレトリーズ
Webhook リファレンス
webhook を検証 - 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 の一覧
既に使用している言語のクライアントをドロップインします。
3つの公式 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",
})
05/コネクターパターン
一度ビルドします。何かに差し込む。
コネクタは PHP クラス 1 つのフォルダーです。 OpsIQ は、イベントのレジストリ ワイヤー、およびプラットフォーム固有のコードは、コアからきれいに分離されます。
コネクターガイド
5つのホック
identityProviders(), contextProviders(), registerActions(), subscribers(), handleWebhook().
マニフェスト主導actions.json とりあえず settings.json コントラクトとコンフィグを宣言します。
自動検出フォルダをドロップし、それを署名し、管理者で有効にします。
意図から安全な行動まで
英語でのプレーン 監査された操作。
OpsIQ は、正しい呼び出しを発明しません。 登録契約を通り抜けてペイロードの準備を行い、アクションが要求されると確認を求め、実行時に完全な監査行を作成して、AIが実行できる アクション 信頼できないAIになることはありません。
契約締結 登録されたアクションだけをAIが提案する。
副作用の前に確認して下さい。 リスクアクションは、プレビューカードを最初に表します。
トータルリコール AIの歴史で捉えられたあらゆるプロンプト、応答および行動結果。
4 手順意図した → 監査
ムアック実行前に署名
発明された呼び出しなし契約レジストリのみ
確認ゲート副作用前のプレビュー
100% 監査プロンプト + 応答 + 結果
リファレンス
OpenAPI 3.0.3 リファレンス
API 表面 一見で。
コアエンドポイント、auth、idempotency、per-key率制限。 全マシン対応の契約はOpenAPI 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 ヘッダ。マシンが読みやすいコントラクト(エンドポイント、スキーマ、エラー)がすべて OpenAPI 3.0.3 リファレンス.
コネクターを造って下さい
コネクターを出荷して下さい 5つのステップ。
コネクタは、自己完結したフォルダです。 OpsIQ は、レジストリがイベントをワイヤーで縛り、プラットフォーム固有のコードはコアに漏れません。
1フォルダを足場で
connector.php 拡張する AbstractConnector.2デコレーション
actions.json とりあえず settings.json メイフェスト。3アイデンティティ、コンテキスト、Webhookプロバイダを実装します。
4気になるイベントを購読してください。
5サインインして、それをドロップし、管理者で有効にします。
発送前にテスト
サンドボックスキーとWebhookテスター。
すべてのワークスペースはサンドボックスを露出します: 生産データに触れることなく同じ API 表面にヒットする別のスコープ付きキー。 使用 POST /v1/webhooks/test 署名されたサンプルをエンドポイントで発射し、ライブを開始する前に、署名検証を確認します。 セルフホストインストールは、クラウドとオンプレミス間の行動的なドリフトなしで、同じコードパスを実行します。
Sandboxキー
Webhook テスター
クローン駆動のジョブ
クラウド&セルフホスト型パシティ
レッスン アシムコレクター エクステンダー AbstractConnector
{
公共機能 キー(): 文字列 { 返品 'acme' は、; }
// 俳優が誰であるかを解決する
公共機能 アイデンティティプロバイダ(): 配列 {
返品 [新規登録 AcmeIdentityProvider()];
}
// ライブデータをAIプロンプトに送ります
公共機能 コンテキストプロバイダー(): 配列 {
返品 [新規登録 AcmeContextProvider()];
}
// OpsIQ イベントに反応する
公共機能 加入者(): 配列 {
返品 ['invoice. paid' ' は、 => [新規登録 BillingMirror()]];
}
// 受信インバウンドのWebhookをAcmeから受け取ります
公共機能 ハンドルWebhook()配列 $body): 無効 { /* … */ }
}
どう比較するか
OpsIQ対 a DIYの統合。
契約締結、署名、監査されたプラットフォームは、あなた自身のwebhookとAIアクション配管を決してロールアウトすることを可能にします。
| 機能の能力 | 自分をロールアウト | 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 | — | ✓ |
よくある質問
開発者の質問, 回答する。
Auth、シグネチャ、SDK、サンドボックス、コネクタモデル:最初のリクエストの前に尋ねるすべてのもの。
API は、スコープ付きベアラーキーで認証を呼び出します。
Authorization: Bearer opq_…. OpsIQ は、何かが実行する前にキーのスコープと俳優の役割をチェックします。 Webhooks は別々です: すべての webhook OpsIQ 送信は、 X-OpsIQ-Signature (生体の六角形 HMAC-SHA256)とアン X-OpsIQ-Timestamp 再再生保護のため、返して確認することができます。送信するインバウンドのWebhookは同じ方法で検証されます。いいえ。AIは、アクション・コントラクトレジストリに存在するアクションだけを提案することができます。呼び出しを発明することはできません。各契約は、許可される表面、役割、パラメータ、およびマークされた任意の行動を宣言します
requires_confirmation サイド効果が実行される前に、プレビューカードを人間に表します。リクルート
hash_hmac('sha256', $rawBody, $secret) (プレフィックスなしのヘックスダイジェスト) それに比較 X-OpsIQ-Signature 定数チェック付きヘッダー()hash_equals)。 配達は、タイムスタンプ、出欠キー、追跡できる配送IDも持ちます。 このページのPHPスニペットは、検証全体です。200 を返さないデリバリーは、指数関数のバックオフで取得され、それぞれ同じ出金キーを持ち、そのリトリッドデリバリーが決してダブルアクションしません。管理者またはログに配送IDによって、すべての試みを追跡できます。
PHP の公式 SDK8.4+, Node.js の18+ と Python3.10+ 署名、リトリーズ、出欠キー、および型付き応答を処理する。 彼らはREST 表面周りの細いラッパーなので、あなたはまた、公開された OpenAPI から独自のクライアントを生成することができます3.0.3契約または電話API直接。
はい。あらゆるワークスペースは同じに当たる独自のスコープ付きキーでサンドボックスを露出させますAPI生産データに触れない表面、プラス
POST /v1/webhooks/test 署名されたサンプルをエンドポイントで消火し、ライブ前に検証を確認するために。はい。 ホストされているインストールは、同一のコードパス(同じ署名、同じコネクタレジストリ、同じOpenAPI契約)を実行しているので、クラウドとオンプレミスの間で動作ドリフトはありません。
コネクタは、PHP クラスを拡張する1つのセルフ・コンテネーションフォルダーです。
AbstractConnector、プラス actions.json とりあえず settings.json マニフェスト。 実装する identityProviders(), contextProviders(), registerActions(), subscribers() とりあえず handleWebhook(). OpsIQ_ 自動ディスカバー、イベントをワイヤーで縛り、プラットフォーム固有のコードをコアからきれいに分離します。