پلتفرم توسعه دهنده · REST · وب سایتhooks · SDKs

ایجاد پلت فرم خود AI-operable

OpsIQمعرفی بازی A Clean RESTAPI, HMAC-sated webhooks, یک رجیستری اکشن و SDK های آماده به کشتی تعریف آنچه که حوادث آتش از سیستم شما، چه اقداماتی AI مجاز به اجرا است و چه داده ها برای خواندن امن است.OpsIQامضاها، سوابق، ثبت های حسابرسی و جریان های تأیید را برای شما اداره می کند.

HMAC-SHA256 هر دو راهوب‌گاه رسمی شرکت پی‌اچ‌پیOpenAPI3.0.3قرارداد قرارداد100%پوشش حسابرسی
درخواست امضا در
ثبت نام Webhook out200OK
زندگی زنده Live ⁇ ⁇OpsIQامضای Webhook POST /v1/actions/run X-OpsIQSignature { "action": «افر_درخ» " تایید شده": واقعی بررسی و ارزیابی امضای ⁇ نقش + دامنه | نامه حسابرسی نوشته شده @opsiq/sdkویجت ویجت در مورد (تغییرمسیر از آن) بررسی HMAC | رسیدگی 200OK
3SDK های رسمی: PHP، Node، Python
HMAC(-)256امضا شده در هر درخواست
40+رویدادهای جهانی برای مشترک
100%پوشش حسابرسی در مورد اقدامات
چرخه عمر درخواست

درخواست در ثبت نام وب سایت به بیرون

شما به سمتOpsIQ APIبا کلید Bearer دامنه شماOpsIQمحدوده و نقش را بررسی کنید، اقدام قراردادی را اجرا کنید، یک ردیف حسابرسی بنویسید - سپس یک وب سایت HMAC امضا شده را به نقطه پایانی خود شلیک کنید.هر پرش معتبر است، idempotent و دوباره در شکست مورد بازجویی قرار می گیرد.

HMAC-SHA256 Webhooks - محموله های وب داخلی و خارجی بر روی بدن خام امضا می شوند.APIتماس های معتبر با یک کلید Bearer دامنه.
خودکارسازی اتوماتیک Retries تحویل های ناموفق و عقب نشینی، با یک شناسه تحویل شما می توانید ردیابی کنید.
کلیدهای احتمالی Idempotency - با طراحی مجدد، ایمن است، بنابراین تحویل مجدد هرگز دو برابر نمی شود.
برنامه شما POST /v1/actions/run X-OpsIQSignature X-OpsIQTimestamp VERIFY - RUNIT پایان نامه شما POST /webhooks HMAC 200OK امضای تایید شده محدوده + نقش بررسی شده اجرای قرارداد نامه حسابرسی نوشته شده WEBHOOK PAYLOAD { "حتی""اقدام. executed" «delivery_id»: "dlv_8f2a9"، "ایده آل"⁇ ایده آل_31c7 "امضا"|sha256=9c4e0a7b" } تحویل داده شده
01 درخواست امضا شده 02 HMAC 03 قرارداد 04 نوشتن ردیف حسابرسی 05 نام گذاری Webhook
آغاز سریع

از صفر تا یک ادغام زنده در چهار قدم

یک کلید را تنظیم کنید، اولین رویداد خود را آتش بزنید، یک وب را به اشتراک بگذارید، یک اقدام ثبت کنید.شما می توانید کل حلقه را در برابر جعبه شنی قبل از لمس داده های تولید اجرا کنید.

کنسول Sandboxاتصال
· ساندویچ 1· کلید طلایی ویژگی های بازی Exq_live_xxx 2آتش یک رویداد POST/v1/events/fire«نظم. کشتی» 3• اشتراک گذاری یک وب سایتhook https://api.you.com/webhooks 4• ثبت یک اقدام · هزینه_inbug
ترویجSandbox - تولید، همان کد
01

یک کلید را بردارید

ثبت نام کنید و یک Bearer دامنه ایجاد کنیدAPIکلید (opq_…• در تنظیمات توسعه دهنده، و هر ادغام را فقط سطوح مورد نیاز خود را ارائه دهید.

02

آتش و مشترک

امضای امضا شده events/fire (یا استفاده از یکSDKو سپس هر نقطه ای راURLدر هر صورت، با یک شناسه تحویل و retries back-off امضا شده است.

03

ثبت یک اقدام

یک قرارداد اقدام امضا شده را امضا کنید تا AI بتواند با خیال راحت عملیات را با بررسی های نقش، سیاست تأیید و یک مسیر حسابرسی کامل اجرا کند.

چگونه با هم سازگار شود

یک الگوی اتصال پنج اصل پاک

هر گونه زندگی خاص پلت فرم در یک کانکتور.OpsIQهسته عمومی باقی می ماند، AI قابل پیش بینی باقی می ماند و ادغام شما قابل حسابرسی است.

01
محرک‌ها (Triggers)

توضیح دهیدOpsIQچه اتفاقی افتاد.

حوادث جهانی آتش از پلت فرم شما - یا نام رویداد سفارشی خود را.هر مشترک در زمان واقعی واکنش نشان می دهد، به ترتیب اولویت.

مرجع Event
invoice.paid حوادث () آتش نشانی () مغز AIمتن زنده قوانیناولویت 20 آینهاولین نوشتن وب سایتhookامضا
رویدادهای سفارشی جهانی +invoice.paid, ticket.created, subscription.cancelled, customer.signed_up یا خود شما. مشترکین Fan-outمغز AI، قوانین اتوماسیون، کانکتورهای آینه و نقاط پایانی وب شما همگی واکنش نشان می دهند. اولویت بندیارسال قطعی آینه ها قبل از آتش هشدار
02قرارداد های عملیاتی

توضیح دهیدOpsIQآنچه که AI مجاز به انجام آن است.

یک قرارداد اقدام امضا شده است.JSONبیانیه: چه کاری انجام می دهد، چه نقش هایی می تواند آن را اجرا کند، چه پارامترهایی را بپذیرد، چه تاییدی لازم است و نقطه پایانی تماس.

طرح Action
AI نمی تواند اقدامات را اختراع کندفقط می تواند از شما بخواهد که کسانی را که ثبت کرده اید اداره کنید. سیاست تاییداقدامات خطرناک باعث می شود یک کارت پیش نمایش قبل از هر گونه عوارض جانبی. نقش + سطح گرم کردنهر عمل، نقش ها و سطوح مجاز به اجرای آن را اعلام می کند.
قرارداد عمل -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دانلود زیرنویس فارسی The POSTsJSONمحموله امضا شده با HMAC-SHA در بدن خام - آن را در چند خط بررسی کنید.

Replay Protectionقابلیت تحویل 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);
04SDKs

مشتریان را برای زبانی که قبلا استفاده می کنید، رها کنید.

سه SDK رسمی با احراز هویت، امضای، retries، کلیدهای قابلیت شناسایی و پاسخ های تایپ شده کار می کنند.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",
})
PHP PHP8.4+Node.js18+Python 3.10+REST · OpenAPI3.0.3
05/ الگوی کانکتور

یک بار بسازید، به هر چیزی تبدیل شوید.

کانکتور یک پوشه با یک کلاس PHP است.OpsIQاین را کشف می کند، رجیستری رویدادها را به هم متصل می کند و کد مخصوص پلت فرم شما به طور تمیز از هسته جدا می شود.

راهنمای هدایت
پنج قلابidentityProviders(), contextProviders(), registerActions(), subscribers(), handleWebhook(). Manifest-basedactions.json و settings.json قراردادها و config را اعلام کنید. کشف خودکارسپس آن را وارد کنید و آن را در داخل آن قرار دهید.
از قصد برای انجام اقدامات امن

انگلیسی ساده عملیات حسابرسی شده

OpsIQهرگز تماس درست را اختراع نکنید، از طریق قراردادهای ثبت شده پیاده روی می کند، محموله را آماده می کند، درخواست تایید زمانی که عمل نیاز به آن دارد، و یک ردیف حسابرسی کامل در هنگام اجرای آن ایجاد می کند، بنابراین AI که می تواند آن را اجرا کند. عمل هرگز به هوش مصنوعی تبدیل نمی شود که نمی توانید به آن اعتماد کنید.

قرارداد ورودی AI فقط اقداماتی را که ثبت کرده اید پیشنهاد می کند.
قبل از عوارض جانبی تایید کنید. اقدامات خطرناک ابتدا یک کارت پیش نمایش را نشان می دهند.
یادآوری کامل هر نتیجه سریع، پاسخ و عمل در تاریخ AI به دست می آید.
4گام های گامقصد حسابرسی
HMACامضا شده قبل از اجرا
«آخرین فاکتور آدم را تأمین کنید» مرحله گام گام1· قطعنامه ← مطابقت: saas. refund_invoice سطح: مدیریت · نقش: مالک · مرحله ۲ تأیید مرحله گام گام3· تایید و امضا پیش نمایش کارت · فاکتور #8421 تایید مرحله گام گام4· ردیف حسابرسی بازیگر · سریع · نتیجه ·412ms تنها مالک · صادراتCSV
هیچ تماس اختراع نشدهثبت قرارداد فقط
تاییدپیش نمایش قبل از عوارض جانبی
100%حسابرسیسریع + پاسخ + نتیجه
مرجع

سطح API در یک نگاه

هر نقطه پایانی هسته ای، حقیقت، هویت و محدودیت نرخ هر کلید است. قرارداد کامل قابل خواندن ماشین در OpenAPI زندگی می کند.3.0.3مرجع

OpenAPI3.0.3مرجع مرجع
پایانامضا..منمحدودیت نرخ
نوشتنامضای جانبی-اثر سطوح
POST /v1/events/fireHMACبله1000/ min
POST /v1/actions/runHMACبله200/ min
POST /v1/webhooks/testHMACبله60/ min
خوانده شدزمینه، بلیط ها و موجودی کانکتور
GET /v1/customers/{id}HMACبله2000/ min
GET /v1/ticketsHMACبله2000/ min
GET /v1/connectorsHMACبله2000/ min

محدودیت های نرخ در هر کلید و بازگشت به هر پاسخ به عنوان X-OpsIQ-RateLimit-Remainingبیش از حد بازگشت 429 با یک Retry-After هدر: قرارداد کامل قابل خواندن ماشین (هر نقطه پایانی، طرح و خطا) در زندگی می کند. OpenAPI3.0.3مرجع مرجع.

ایجاد یک کانکتور

کشتی یک کانکتور در پنج قدم

یک کانکتور یک پوشه مستقل است.OpsIQاین را کشف می کند، رجیستری رویدادها را ارائه می دهد و کد خاص پلت فرم شما هرگز به هسته نفوذ نمی کند.

1یک پوشه با Scaffold connector.php گسترش AbstractConnector.
2دسامبرlare actions.json و settings.json آشکار
3پیاده سازی هویت، زمینه و ارائه دهندگان وب را فریب.
4به رویدادهایی که به آن اهمیت می دهید، اشاره کنید.
5آن را ثبت کنید، آن را در داخل آن قرار دهید.
تست قبل از کشتی

یک کلید sandbox و یک تست کننده وب را بزنید.

هر فضای کاری یک Sandbox را افشا می کند: یک کلید جداگانه که به همان نقطه برخورد می کند.APIسطح بدون لمس کردن داده های تولید POST /v1/webhooks/test برای شلیک یک نمونه امضا شده در نقطه پایانی شما و تأیید تایید امضای خود قبل از رفتن به زندگی. نصب‌های خود- میزبان مسیر کد مشابه را اجرا می‌کنند، بدون هیچ حرکت رفتاری بین ابر و بر روی محل.

کلیدهای Sandbox تست Webhook مشاغل مبتنی بر Cron Cloud & Self-hosted Parity
کانکتور. php · php
کلاس AcmeConnector گسترش AbstractConnector { عملکرد عمومی کلید () : رشته { بازگشت برگشت «م»; } حل اینکه بازیگر کیست عملکرد عمومی هویت () : آرایه { بازگشت برگشت [جدید AcmeIdentityProvider()]; } *اطلاعات زنده را به سرعت AI عملکرد عمومی متن () : آرایه { بازگشت برگشت [جدید AcmeContextProvider()]; } React toOpsIQحوادث عملکرد عمومی () مشترک: آرایه { بازگشت برگشت [«در صدا» پرداخت => [جدید BillingMirror()]]; } دانلود بازی Inbound webhooks از Acme عملکرد عمومی مدیریت Webhook (آرایه $body): خالی از خلاء { /* … */ } }
چگونه مقایسه می کند

OpsIQدر مقابل ادغام DIY

چه یک پلت فرم قرارداد، امضا شده، حسابرسی به شما می دهد که نورد وب سایت خود و لوله کشی AI-action هرگز نخواهد بود.

قابلیتخودتان را رول کنید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 ها، Sandbox و مدل اتصال: همه چیزهایی که قبل از درخواست اول از آن می پرسید.

APIتماس های معتبر با یک کلید خرسی تک دامنه: ارسال Authorization: Bearer opq_…. OpsIQمحدوده کلید و نقش بازیگر را قبل از هر چیزی که اجرا می شود، بررسی کنید. Webhooks جداگانه است: هر وب سایتhooksOpsIQارسال یک X-OpsIQ-Signature (یک HMAC-256 از بدن خام) و یک X-OpsIQ-Timestamp برای محافظت مجدد، بنابراین شما می توانید ما را در عوض تأیید کنید و وب سایت های ورودی که ارسال می کنید به همان روش تایید شده اند.
AI تنها می تواند اقداماتی را که در رجیستری عمل شما وجود دارد پیشنهاد کند، نمی تواند یک تماس ایجاد کند. هر قرارداد سطوح، نقش ها و پارامترهای مجاز را اعلام می کند و هر گونه اقدام مشخص شده نشان می دهد. requires_confirmation یک کارت پیش نمایش را به یک انسان قبل از عوارض جانبی اجرا می کند.
محاسبه مجدد hash_hmac('sha256', $rawBody, $secret) (یک پیشوند Hx هضم بدون پیشوند) و مقایسه آن با پیشوند X-OpsIQ-Signature هدر با یک چک زمان ثابت (hash_equalsهر تحویل همچنین دارای یک timetamp، یک کلید idempotency و یک شناسه تحویل است که می توانید آن را ردیابی کنید.کل قطعه PHP در این صفحه است.
تحویل هایی که بازگشتی ندارند200با back-off نمایی دوباره مورد توجه قرار می گیرند، هر کدام از آنها کلید همان idempotency را حمل می کنند، بنابراین تحویل مجدد هرگز دو برابر نمی شود.شما می توانید هر تلاش را با تحویل ID در admin یا log های خود ردیابی کنید.
SDK های رسمی برای PHP8.4+ Node.js18+ و پایتون3.10+ امضای، retries، کلیدهای قابلیت شناسایی و پاسخ های تایپ شده.آنها بسته بندی نازک در اطراف سطح REST هستند، بنابراین شما همچنین می توانید مشتری خود را از OpenAPI منتشر شده تولید کنید.3.0.3قرارداد یا تماس باAPIمستقیم.
بله، هر فضای کاری یک جعبه شنی را با کلید دامنه خود که به همان برخورد می کند، نشان می دهد.APIسطح بدون لمس کردن داده های تولید، به علاوه POST /v1/webhooks/test برای شلیک یک نمونه امضا شده در نقطه پایانی شما و تأیید اعتبار قبل از رفتن به حالت زنده.
بله، نصب های خود میزبان مسیر کد یکسان (همان امضای، همان رجیستری، همان قرارداد OpenAPI) را اجرا می کنند، بنابراین هیچ حرکت رفتاری بین ابر و بر روی پیش بینی وجود ندارد.
یک کانکتور یک پوشه مستقل با یک کلاس PHP است که گسترش می یابد. AbstractConnectorبه علاوه، actions.json و settings.json آشکاری که شما پیاده سازی می کنید identityProviders(), contextProviders(), registerActions(), subscribers() و handleWebhook(). OpsIQکشف خودکار آن، رویدادها را سیم می کند و کد خاص پلت فرم خود را به صورت تمیز از هسته جدا می کند.