פלטפורמת פיתוח: RESThooks - SDKs

עשה את הפלטפורמה שלך AI-Operable

OpsIQחושף REST נקיAPIHMAC-signed Webhooks, רישום פעולה ו- Ready-to-ship SDKs. Define איזה אירועים יורים מהמערכת שלך, אילו פעולות ה-AI מותר לרוץ, ומה הנתונים בטוחים לקריאה.OpsIQלהתמודד עם חתימות, חזרות, יומני ביקורת ותזרימי אישור עבורך.

HMAC-SHA256 הן דרכיםPHP - NodeOpenAPI3.0.3החוזה100%סיקור ביקורת
הבקשה ב
webhook חתום יוצא → 200 OK
חי תגית:OpsIQחתומה על Webhook POST /v1/actions/run X-OpsIQ_-Signature { "action": "refund_inחשבונית" "מובטח": אמת VERIFY - RUNIT חתימה תפקיד + TER ביקורת שורות @opsiq/sdkwidget (ב) על ידי פעולה. executed) אימות HMAC 200 OK
3ראשי התיבות של PHP, Node, Python
HMACSHA-256חתום על כל בקשה
40+אירועים אוניברסליים להירשם
100%סיקור ביקורתי על פעולות
מחזור החיים של הבקשה

בקשה. חתום Webhook בחוץ.

אתה מתנגד לOpsIQ APIעם מפתח ה- Bearer שלך.OpsIQהסימון היקף ותפקיד, מנהל את הפעולה המוקצבה, כותב שורה ביקורתית - ואז יורה רשת מוקצה HMAC חזרה לנקודת הקצה שלך.כל הופ הוא אותנטי, idempotent ו retried על כישלון.

HMAC-SHA256 Webhooks - עומסי תשלום מוכנסים ומחוץ ל-webhook חתומה על הגוף הגולמי;APIשיחות אותנטיות עם מפתח צריח קבוע.
Retries אוטומטי - משלוחים כושלים הלוך ושוב, עם מזהה משלוח אתה יכול לעקוב.
מפתחות - חזרה על עצמה באמצעות עיצוב, כך משלוח משוחזר לעולם לא כפול.
האפליקציה שלך POST /v1/actions/run X-OpsIQ_-Signature X-_OpsIQTimestamp וודאי - הפעל - ביקורת נקודת הקצה שלך POST /webhooks אימות HMAC 200 OK חתימה מאומתת מיקום + Office Check פעולה מגובשת ביקורת שורות תגית: Oh PAYLOAD { "אפילו""פעולה. exeated" "Delivery_id""Dlv_8f2a9" "כוח_קי""idem_31c7" "החתימה""sha256=9c4e0a7b..." } נמסר
01 בקשה חתום 02 אימות HMAC 03 החוזה 04 ביקורת שורות 05 חתום Webhook
התחלה מהירה

מ-אפס לשילוב חי ארבעה צעדים

ליצור מפתח, לירות את האירוע הראשון שלך, להירשם לפעולה.אתה יכול להפעיל את הלולאה כולה נגד ארגז החול לפני נוגע בנתונים לייצור.

קונסולת Sandboxמחובר
DeVELOPER CONSOLE - ארגז חול 1• יצירת מפתח ⁇ _ ⁇ - One scaled Bearer מפתח 2אש אירוע POST/v1/events/fire"הסדר" 3Subscribe a Webhook → https://api.you.com/webhooks 4• לרשום פעולה saas. refund_inחשבונית - ביקורת
קידוםSandbox הפקה, אותו קוד
01

קבל מפתח

היכנסו ויצרו דובדבןAPIמפתח (opq_…(בהגדרות מפתח, ולתת לכל שילוב רק את פני השטח שהוא צריך.

02

Fire & מנוי

חתומה על events/fire (או להשתמש)SDKואז להצביע על כלURLבכל מקרה, חתום, עם מזהה משלוח וחזור אחורי.

03

רשום פעולה

חתיכה בחוזה פעולה חתום כך ש-AI יכול להפעיל בבטחה פעולות, עם בדיקות תפקידים, מדיניות אישור ונתיב ביקורת מלא.

איך זה משתלב ביחד

דפוס מחבר אחד חמישה פרימיטיביים נקיים

כל דבר ספציפי לפלטפורמה חי בחבר.OpsIQהליבה נשארת גנרית, AI נשאר צפוי, והשילוב שלך נשאר ביקורתי.

01
טריגרים

ספר לספרOpsIQמה בדיוק קרה.

אירועי אש אוניברסליים מהפלטפורמה שלך - או שמות אירועים מותאמת אישית משלך.כל המנוי מגיב בזמן אמת, בסדר עדיפות.

אירוע
invoice.paid אירועים. fire() המוח של AIההקשר חי כלליםעדיפות20 מראהלכתוב קודם WEBhookחתום
אירועים מותאמים אישיתinvoice.paid, ticket.created, subscription.cancelled, customer.signed_up או שלך. מנויים Fan-outהמוח AI, כללי אוטומציה, מחברים מראות ונקודות הקצה של האינטרנט שלך מגיבים כולם. סדר עדיפותלשלוח כל כך מראות לכתוב לפני שהזהיר את האש.
02חוזים פעולה

ספר לספרOpsIQמה אפשר לעשות AI.

חוזה פעולה הוא הסכם חתוםJSONהצהרה: מה הפעולה עושה, אילו תפקידים יכולים להפעיל אותה, אילו פרמטרים היא מקבלת, בין אם נדרשת אישור, לבין נקודת הקצה.

פעולה schema
AI לא יכול להמציא פעולותזה יכול רק לבקש לרוץ את אלה שנרשמת. מדיניות אישורפעולות מסוכנות מעוררות כרטיס תצוגה מקדימה לפני כל תופעות לוואי. תגית + Surface 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

לדחוף אירועים לערימתך - עם הוכחה קריפטוגרפית.

Subscribe כלURLלכל אירוע.OpsIQPOSTS THEJSONמטען חתום עם HMAC-SHA256 על הגוף הגולמי - לאמת אותו בכמה קווים.

Replay Protectionזיהוי משלוחיםBack-off Retries
המונחים:
מיפוי 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/ SDKs

לקוחות להורדת שפה כבר משתמשים.

שלושה SDKs רשמיים להתמודד עם אימות, חתימה, רפידות, מפתחות idempotency ותגובות מקלות.או להישאר ללא מסגרת - כל אחד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",
})
PHP8.4+Node.js18+Python3.10+תגית: OpenAPI3.0.3
05תבנית המחבר

צור פעם. Plug into anything

מחבר הוא תיקיה עם מחלקה PHP אחת.OpsIQמגלה את זה, הרישום חוט את האירועים, ואת הקוד הספציפי של הפלטפורמה שלך נשאר מופרד באופן נקי מן הליבה.

מדריך
5 תפוזיםidentityProviders(), contextProviders(), registerActions(), subscribers(), handleWebhook(). המונחים: manifestactions.json ו settings.json להכריז על חוזים ו- config. גילוי אוטומטיזרוק את התיקיה, לחתום על זה, לאפשר לו בניהול.
מתוך כוונה לפעולה בטוחה

אנגלית פשוטה פעולה מאובחנת.

OpsIQ אף פעם לא ממציאה את השיחה הנכונה. היא עובר דרך החוזים הרשומים, מכינה את העומס, מבקשת אישור כאשר הפעולה דורשת זאת, ומפיקה שורת ביקורת מלאה כאשר היא מבצעת, כך ש-AI שיכול מעשה פעולה לעולם אל תהפוך לבינה מלאכותית שאי אפשר לסמוך עליה.

החוזה. ה-AI מציע רק פעולות שנרשמת.
אישור לפני תופעות לוואי. פעולות מסוכנות על פני כרטיס תצוגה מקדימה ראשון.
סה"כ זיכרון. כל תוצאה מהירה, תגובה ופעולה שנלכדה ב-AI History.
4צעדיםביקורת
HMACחתום לפני ביצוע
"החשבונית האחרונה של אדם" צעד צעד1· החלטה שם הסרטון: saas. refund_invoice שם מקור: admin - Role: Husbands2אימות תוקף צעד צעד3• אישור וסימן כרטיס תצוגה: חשבונית #8421 אישור צעד צעד4שורת ביקורת תוצאה:412ms בעלים בלבד - מייצאCSV
לא המציאו שיחותרישום החוזה רק
אישורתצוגה מקדימה לפני תופעות לוואי
100%ביקורתתגובה + תוצאות
המונחים

APIמשטח במבט אחד.

כל נקודת קצה הליבה, האתיופי שלה, החסינות והקצבה ל- per-key.החוזה המלא של המכונה חי ב- OpenAPI3.0.3התייחסות.

OpenAPI3.0.3המונחים
סוףאותאימפוטנט.הגבלת מחירים
לכתובמשטחים של תופעות לוואי
POST /v1/events/fireHMACכן1000/ min
POST /v1/actions/runHMACכן200/ min
POST /v1/webhooks/testHMACכן60/ min
קרא Readהמונחים: tab and connector
GET /v1/customers/{id}HMACכן2000/ min
GET /v1/ticketsHMACכן2000/ min
GET /v1/connectorsHMACכן2000/ min

גבולות הריבית הם המפתח וחזרו על כל תגובה כמו X-OpsIQ-RateLimit-Remainingמעל לכיסוי חוזר 429 עם A Retry-After החוזה המלא המכונה (כל נקודת קצה, סכימה וטעייה) חי בחיים ב-The מכונות המלאות. OpenAPI3.0.3המונחים.

לבנות מחבר

ספינה מחבר 5 צעדים

מחבר הוא תיקיה המכילה עצמי.OpsIQמגלה את זה, הרישום חוט את האירועים, ואת הקוד הספציפי של הפלטפורמה שלך לעולם לא דולף לתוך הליבה.

1סקאפר היה תיקיה עם connector.php הרחבה AbstractConnector.
2צו actions.json ו settings.json ביטויים.
3יישום זהות, קונטקסט וספקי Webhook.
4הירשם לאירועים שאכפת לך מהם.
5היכנסו, הורידו אותו, אפשרו לו בניהול.
מבחן לפני שאתם ספינה

מפתח ארגז חול ובדיקת Webhook.

כל סביבת עבודה חושפת ארגז חול: מפתח קבוע נפרד שמכה את אותו הדברAPIפני השטח ללא נגיעה בנתונים לייצור. השתמש POST /v1/webhooks/test כדי לירות במשלוח מדגם חתום בנקודת הקצה שלך ולאשש את אימות החתימה שלך לפני שאתה חי.התקנות מעוות עצמית להפעיל את נתיב הקוד הזה, ללא סחף התנהגותי בין ענן ו- ON-prem.

מפתח Sandbox Webhook Tester עבודות מונעות Cron ענן ודעה עצמית
מחבר:php
הכיתה רכיב מסנן מרחיב AbstractConnector { תפקוד ציבורי מפתח (): מחרוזת { החזרה חוזרת "me"; } - לפתור מי השחקן תפקוד ציבורי זהות (): מערך { החזרה חוזרת [חדש AcmeIdentityProvider()]; } • להאכיל נתונים חיים ל-AI תפקוד ציבורי המונחים: מערך { החזרה חוזרת [חדש AcmeContextProvider()]; } תגובהOpsIQאירועים תפקוד ציבורי מנויים (): מערך { החזרה חוזרת ["חשבונית. => [חדש BillingMirror()]]; } קבלו את Webhoos inbound תפקוד ציבורימערך $body): OUT { /* … */ } }
איך זה משווה

OpsIQלעומת שילוב DIY

איזו פלטפורמה ריבונית, חתום, פלטפורמה ביקורתית נותנת לך כי מתגלגלת ה-Webhooks שלך ו- AI-action צנרת לעולם לא תרצה.

יכולת Capabilityרוץ בעצמך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) VIR
Connector pattern: platform code stays isolated
שאלות נפוצות

שאלות מפתח, ענה.

אות, חתימות, SDKs, ארגז חול ומודל המחבר: כל מה שתבקש לפני הבקשה הראשונה.

APIשיחות אותנטיות עם מפתח יחיד קבוע: שלח Authorization: Bearer opq_…. OpsIQבודקים את היקף המפתח ואת תפקידו של השחקן לפני כל דבר פועל. Webhooks הם נפרדים: כל WebhookOpsIQשולח נושא X-OpsIQ-Signature (ה-HMAC-SHA256 של הגוף הגולמי) X-OpsIQ-Timestamp כדי לשחזר את ההגנה, כך שתוכל לאמת אותנו בתמורה, ו webhooks הנכנסים מאומתים באותה הדרך.
לא.הבינה המלאכותית יכולה רק להציע פעולות הקיימות במרשם הפעולה-הפעולה שלך, היא אינה יכולה להמציא שיחה.כל חוזה מצהיר על פני השטח, התפקידים והפרמטרים המותרים, וכל פעולה המסומנים requires_confirmation מעל פני כרטיס תצוגה מקדימה לאדם לפני שהתוצאה של הצד.
חישוב מחדש hash_hmac('sha256', $rawBody, $secret) (הגש לעכל ללא תיקון) ולהשוות אותו ל[דרוש מקור] X-OpsIQ-Signature ראשי תיבות של aקבוע-time Check (hash_equalsכל משלוח נושא גם את חותמת פעמים, מפתח idempotency ו מזהה משלוח שאתה יכול לעקוב.ה-P PHP snippet בדף זה הוא אימות שלם.
אספקה שלא מחזירה200הם retried עם החזר אקספוננציאלי, כל נושא את אותו מפתח idempotency כך משלוח retried לעולם לא כפול-acts. אתה יכול לעקוב אחר כל ניסיון על ידי מתן מזהה בניהול או יומני שלך.
ה- SDK הרשמי של PHP8.4תגית: Node.j18+ Python3.10+ להתמודד עם חתימה, רפידות, מפתחות idempotency ותגובות ממותקים.הם עוטפים דקים סביב פני השטח REST, כך שתוכל גם ליצור את הלקוח שלך מן ה- OpenAPI המפורסם.3.0.3חוזה או התקשרAPIישירות.
כן, כל חלל עבודה חושף ארגז חול עם מפתח מעוקל שלו שמכה אותו הדברAPIפני השטח ללא נגיעה בנתונים של ייצור, בנוסף POST /v1/webhooks/test כדי לירות משלוח מדגם חתום בנקודת הקצה שלך ולאשר את האימות שלך לפני שאתה הולך לחיות.
כן, התקנה עצמית של עצמי מפעילה את נתיב הקוד הזה (אותו חתימה, אותו מרשם מחבר, אותו חוזה OpenAPI) כך שאין סחף התנהגותי בין ענן ו- ON-prem.
מחבר הוא תיקיה המכילה את עצמה עם מחלקה PHP אחת מרחיבה AbstractConnector, בתוספת actions.json ו settings.json ביטויים. Youיישם identityProviders(), contextProviders(), registerActions(), subscribers() ו handleWebhook(). OpsIQגילוי אוטומטי זה, חוט את האירועים ושומר על הקוד הספציפי של הפלטפורמה שלך מופרדים באופן נקי מן הליבה.