Nhà phát triển nền tảng . REST_· Weboks__ SDKs

Tạo nền tảng cho bạn Dễ thương.

OpsIQ vạch trần một nền tảng sạch sẽAPI , HMAC, một trang web được ký kết, một danh sách hành động và sẵn sàng để tàu SDKs. Xác định những gì sự kiện bắn ra từ hệ thống của bạn, những hành động AI được cho phép chạy, và dữ liệu nào an toàn để đọc.OpsIQ Cầm lấy chữ ký, trả lời, nhật ký kiểm tra và xác nhận lưu lượng cho anh.

HMAC-SHA256 cả hai cáchPHP # Node e· Python SDKsOpenAPI3.0.3 Hợp đồng100% Kiểm tra lại
Yêu cầu đăng ký vào
Ô cửa sổ đã ký kết200 Được rồi
Sống Làm congOpsIQ Trình chọn & màu POST /v1/actions/run X-OpsIQ- Dấu hiệu { "action": "đã được giải quyết" "Chắc chắn" : đúng ! VERIFY_* chạy ·ADIT Chữ ký _ nền vai + phạm vi _ nền Kế toán được viết @opsiq/sdk Ô điều khiển trên ("hành động. executed") Xác minh xử lý HMAC 200 Được rồi
3SDKs chính thức: PHP, Node, Python
HMACTạm biệt.256 Đã ký vào mọi yêu cầu
40+Các sự kiện phổ thông để đăng ký
100%Comment
Chiếc xe đạp cứu sinh

Yêu cầu vào. Ký tên vào webhook.

Bạn PST đếnOpsIQ API với chìa khóa kính hiển vi của anh.OpsIQ Kiểm tra phạm vi và vai trò, chạy hành động hợp đồng, viết một hàng kiểm tra - sau đó bắn một cây móc mạng HMAC trở lại điểm cuối của bạn.

Các lưỡi câu HMAC-SHA256 - Hàng hóa đã được ký trên cơ thể sống;API Gọi xác thực với một khóa read Bearer.
Tự động đặt lại - không thể lấy lại và thử lại, với một chứng minh thư giao hàng.
Phím vô hạn - An toàn theo thiết kế, nên giao hàng lại không bao giờ được tái lập.
Ứng dụng của bạn POST /v1/actions/run X-OpsIQ- Dấu hiệu X-OpsIQ- Đóng dấu thời gian VERIFY - TIẾNG Điểm cuối của bạn POST /webhooks Xác nhận HMAC 200 Được rồi Xác nhận chữ ký Phạm vi + vai trò được kiểm tra Hành động đã kết hợp chạy Kế toán được viết TẢI TRỌNG WEBHOOK ĐÃ KÝ { "Chào""hành động. bị cắt" "livery_id": "Dlv_8f2a9", "Dành vực": "Dìa theo 31c7", "Triển": "sha256 =9c4e0a7b..." } đã chuyển
01 Yêu cầu kí tên 02 Xác nhận HMAC 03 chạy hợp đồng 04 viết bài kiểm toán 05 móc câu đã ký
Chạy nhanh

Từ 0 đến sự hòa nhập trực tiếp 4 bước.

Tạo ra một chìa khóa, khởi động sự kiện đầu tiên, đăng ký một cây móc, đăng ký hành động.

Bàn giao tiếp hộp cátĐã kết nối
D khôi phục hộp cát 1Tuỳ biến opq_live_xxx_· Một phím gấu bao quát 2· Bắn một sự kiện PST/v1/events/fire"được sắp xếp. 3Tuỳ biến → https://api.you.com/webhooks 4 . Đăng ký một hành động Không có gì.
Nâng caoHộp cát sản xuất, cùng mã
01

Lấy chìa khóa đi.

Đăng ký và tạo ra một máy thu âmAPI Phím (opq_…) Trong các thiết lập phát triển, và chỉ cho mỗi bề mặt mà nó cần.

02

& dài hạn về lửa

ĐÃ CÓ events/fire (hoặc sử dụng aSDK ), sau đó chỉ bất kỳURL ở bất kỳ sự kiện nào, ký tên, với chứng minh thư giao hàng và trả lại.

03

Đăng ký một hành động

Tuyên bố một hợp đồng hành động đã được ký để AI có thể an toàn thực hiện các hoạt động, với kiểm tra vai trò, chính sách xác nhận và theo dõi toàn bộ.

Làm sao nó hợp với nhau được?

Một kiểu kết nối. 5 người nguyên thủy sạch sẽ.

Bất cứ điều gì cụ thể sống trong một kết nối.OpsIQ Trung tâm vẫn là chung, AI luôn có thể đoán trước được, và sự tích hợp của anh vẫn có thể kiểm toán.

01
Trình kích hoạt

NóiOpsIQ những gì vừa xảy ra.

Mỗi người đăng ký theo thời gian thực, theo thứ tự ưu tiên.

tham chiếu sự kiện
invoice.paid sự kiện. fire () Bộ não AlVăn cảnh sống quy tắcƯu tiên20 phản chiếuviết trước móc câu
Biến cố chung + tùy chỉnhinvoice.paid, ticket.created, subscription.cancelled, customer.signed_up hoặc của chính anh. Đăng ký kiểu hâm mộNão AI, quy tắc tự động hóa, gương kết nối và điểm kết thúc mạng lưới của bạn tất cả đều phản ứng. Thứ tự ưu tiênThông điệp định kỳ do đó gương viết trước khi báo động lửa.
02 Hợp đồng / Hành động

NóiOpsIQ Những gì AI được phép làm.

Hợp đồng hành động đã được ký.JSON khai báo: những gì hành động làm, mà vai trò có thể chạy nó, những gì nó chấp nhận, nếu cần xác nhận, và điểm kết thúc để gọi.

Hành động
AI không thể phát minh ra hành độngNó chỉ có thể yêu cầu điều hành những cái mà anh đã đăng ký. Xác nhận chính sáchHành động nguy hiểm sẽ gây ra một thẻ xem thử trước khi có hiệu ứng phụ nào. Nhiệm vụ và hình dạngMỗi hành động tuyên bố vai trò và bề mặt cho phép thực hiện nó.
- Hợp đồng hành động -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/ Các móc nối đã ký

Đẩy sự kiện vào chồng của bạn - với bằng chứng mật mã.

Đăng ký bất kỳURLcho bất kỳ sự kiện nào.OpsIQPSTsJSON Hàng đã được ký với HMAC-SHA256 trên cơ thể sống - xác nhận nó trong một vài dòng.

Chơi lại biện pháp bảo vệID giao hàng theo dõiCác nhắc lại lùi
Tham chiếu Kiok
Kiểm tra & mạng - 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

Khách hàng bỏ vào cho ngôn ngữ mà anh đã dùng.

Ba SDK chính thức xử lý xác thực, ký, thử lại, khóa idempotency và phản hồi kiểu. Hoặc giữ không có khung - mỗi SDK là một lớp mỏng quanh cùng một bề mặt REST.

ví dụ ứng dụng khách
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+TIẾNG · OpenAPI3.0.3
05/ Mô hình kết nối

Xây dựng một lần, cắm vào bất cứ thứ gì.

Một kết nối là một thư mục với một lớp PHP.OpsIQ Phát hiện ra nó, đăng nhập nối các sự kiện, và mã lệnh cụ thể của anh sẽ được tách biệt khỏi lõi.

Hướng dẫn kết nối
Năm mócidentityProviders(), contextProviders(), registerActions(), subscribers(), handleWebhook(). Hiệnactions.jsonsettings.json Hãy tuyên bố hợp đồng và xác nhận lại. Tự động phát hiệnBỏ thư mục vào, ký vào, cho phép nó trong Adam.
Từ mục đích đến hành động an toàn

Nói tiếng Anh rõ ràng. Đã thử nghiệm chiến dịch.

OpsIQ Không bao giờ phát minh ra cuộc gọi đúng. và tạo ra một hàng kiểm toán đầy đủ khi nó thực hiện, để một AI có thể làm được hành động Không bao giờ trở thành AI mà bạn không thể tin tưởng.

Hợp đồng. AI chỉ đề nghị hành động mà anh đã đăng ký.
Xác nhận trước khi có hiệu quả phụ. Hành động rủi ro xuất hiện trước một thẻ xem thử.
Hoàn toàn được triệu hồi. Mọi động tác, phản ứng và hành động đều được ghi lại trong lịch sử Al.
4 bướcKiểm tra ý định
HMACĐã ký trước khi thực hiện
"Tặng hóa đơn cuối cùng của Adam" Step1 Độ phân giải ý định # _Táo hợp: saas. refud_inice bề mặt: admin · vai: người sở hữu e· Step2 Xác thực Step3& Xác nhận... hóa đơn xem thử lá bài 2 #8421 Xác nhận Step4· Audit hàng Diễn viên l· ee e· kết quả e·412ms Chỉ có quyền sở hữu # xuất khẩu nhưCSV
Không có cuộc gọi nào được phát minhChỉ đăng ký hợp đồng
Xác nhậnxem thử trước hiệu ứng phụ
100% Đã kiểm toánnhắc + kết quả +
Tham khảo

API bề mặt Trong nháy mắt.

Mỗi điểm kết thúc lõi, môi trường, sự thuần khiết và mức độ tối đa mỗi phím.3.0.3 Có liên quan.

OpenAPI3.0.3 tham chiếu
Điểm kết thúcThẩm quyềnBất lựcGiới hạn
GhiCác bề mặt hiệu ứng phụ đã ký
POST /v1/events/fireHMACVâng1000/ phút
POST /v1/actions/runHMACVâng200/ phút
POST /v1/webhooks/testHMACVâng60/ phút
ĐọcVăn bản, vé và kho kết nối
GET /v1/customers/{id}HMACVâng2000/ phút
GET /v1/ticketsHMACVâng2000/ phút
GET /v1/connectorsHMACVâng2000/ phút

Giới hạn là trên một phím và trả lời mỗi khi X-OpsIQ-RateLimit-Remaining; vượt quá giới hạn trở về 429 có một Retry-After Hợp đồng đọc được đầy đủ (mọi điểm kết thúc, giản đồ và lỗi) sống trong các OpenAPI3.0.3 tham chiếu.

Tạo một kết nối

Chuyển một thiết bị kết nối vào 5 bước.

Liên kết là một thư mục tự quản lý.OpsIQ Phát hiện ra nó, đăng nhập nối các sự kiện, và mã lệnh cụ thể của anh không bao giờ rò rỉ vào lõi.

1Co dãn thư mục với connector.php mở rộng AbstractConnector.
2Khai báo actions.jsonsettings.json Bản kê khai.
3Danh tính được tăng cao, ngữ cảnh và nhà cung cấp webok.
4Hãy tin tưởng vào những sự kiện mà anh quan tâm.
5Ký đi, bỏ xuống, cho phép nó được quản trị.
Kiểm tra trước khi lên tàu.

Chìa khóa hộp cát và một cái máy thử ra-đa.

Mỗi không gian làm việc phơi bày một hộp cát: một chiếc chìa khóa được bao quát riêng biệt để chạm vào cùng mộtAPI Hãy dùng dữ liệu về sản xuất, không chạm vào bề mặt. POST /v1/webhooks/test để bắn một mẫu được ký vào điểm cuối và xác nhận sự xác thực chữ ký của bạn trước khi đi. cài đặt tự lập chạy đường mã giống hệt nhau, không có hành vi trôi dạt giữa đám mây và trên trang web.

Phím cát Trình thử móc cắm Web Công việc điều khiển bằng sắt Tinh thể tự & tạo đám mây
kết nối. php .· php
Hạng AcmeConnations mở rộng AbstractConnector { Chức năng công cộng Phím(): chuỗi { trở lại "Ceme"; } / Quyết định ai là diễn viên Chức năng công cộng Bộ xác minh: dãy { trở lại [mới AcmeIdentityProvider()]; } / Nạp dữ liệu trực tiếp vào dấu nhắc AI Chức năng công cộng Trình bảo vệ ngữ cảnh (): dãy { trở lại [mới AcmeContextProvider()]; } // Đáp ứngOpsIQ sự kiện Chức năng công cộng Những người đăng ký (): dãy { trở lại ["tặng tiền". => [mới BillingMirror()]]; } / Nhận các kết nối web từ Acme Chức năng công cộng Xử lý Wubok(dãy $body): khoảng trống { /* … */ } }
_ Nó so sánh như thế nào

OpsIQvs a Sự kết hợp giữa hai người.

Một cái bục kiểm toán, ký tên, cho phép bạn tự xoay cái móc câu và hệ thống ống nước hoạt động AI sẽ không bao giờ quay được.

Khả năngTự mình nhảy đi.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) Biến thế
Connector pattern: platform code stays isolated
Câu hỏi thường gặp

Những câu hỏi của nhà phát triển, trả lời.

Auth, chữ ký, SDKs, hộp cát và mô hình kết nối: mọi thứ bạn sẽ yêu cầu trước yêu cầu đầu tiên.

API Gọi xác thực với một phím Bearer có phạm vi riêng: gửi Authorization: Bearer opq_…. OpsIQ Kiểm tra phạm vi khóa và vai trò của diễn viên trước khi chạy.OpsIQ gửi mang một X-OpsIQ-Signature (a hex HMAC-SHA256 của cơ thể sống) và một X-OpsIQ-Timestamp để bảo vệ lại, để anh có thể kiểm tra lại chúng tôi, và các móc nối anh gửi tới được xác nhận như vậy.
Không. AI chỉ có thể đề xuất hành động tồn tại trong danh sách hành động đối lập của bạn. Nó không thể tạo ra cuộc gọi. mỗi hợp đồng tuyên bố bề mặt, vai trò và tham số được cho phép, và bất kỳ hành động nào được đánh dấu requires_confirmation hiện một thẻ xem thử cho con người trước khi hiệu ứng phụ chạy.
Tính toán hash_hmac('sha256', $rawBody, $secret) (a hex tiêu hóa mà không có tiền tố) và so sánh nó với X-OpsIQ-Signature Đầu đề với kiểm tra thường xuyên (hash_equalsMỗi lần giao cũng mang theo một dấu hiệu thời gian, một chìa khóa vô hạn và một thẻ chuyển phát mà bạn có thể truy ra.
Giao hàng mà không trả lại200 được tái kết nối với cấp số nhân, mỗi người mang cùng một chìa khóa vô hạn để giao hàng không bao giờ có hai cửa hàng.
Đặc điểm SDK chính thức cho PHP8.4+, Node.js18+ và Python3.10+ xử lý việc ký, tái tạo, mã nhận diện phím và đáp ứng gõ.3.0.3 Hợp đồng hay gọi làAPI trực tiếp.
Mỗi không gian làm việc phơi bày một hộp cát với chìa khóa được đo của riêng nó chạm vào cùng mộtAPI dữ liệu sản xuất, cộng với POST /v1/webhooks/test để bắn một mẫu vật đã được ký ở cuối điểm và xác nhận xác thực của anh trước khi trực tiếp.
Phải, cài đặt tự lập chạy đường mã giống hệt nhau (cũng ký kết, cùng liên kết, hợp đồng OpenAPI) nên không có sự trôi dạt hành vi giữa đám mây và trên trang web.
Một kết nối là một thư mục tự bảo vệ với một lớp học PHP mở rộng AbstractConnector, cộng với actions.jsonsettings.json Các bản kê khai, các bạn thi hành identityProviders(), contextProviders(), registerActions(), subscribers()handleWebhook(). OpsIQ Tự động lấy nó, nối dây các sự kiện và giữ cho hệ thống của bạn được tách biệt khỏi lõi.