Developerská platforma · REST · webhooks · SDKs

Urobte si platformu Al-operovateľný.

OpsIQodhaľuje čistý RESTAPI, HMAC-podpísaný webhooks, akčná-zmluvný register a ready-to-ship SDKs. Definovať, aké udalosti požiaru z vášho systému, aké akcie AI je dovolené spustiť, a aké údaje je bezpečné čítať.OpsIQmanipuluje s podpismi, záznamami, auditmi a potvrdzovacími tokmi.

HMAC-SHA256 oboma spôsobmiPHP · Uzol · Python SDKsZmluva OpenAPI 3.0.3100% pokrytie auditu
Podpísaná žiadosť
Podpísaný webhok out → 200 OK
Živé → OpsIQ → podpísaný webhook POST /v1/actions/run X-OpsIQ-Podpis { "action": "refund_faktúra," "Potvrdené": pravda } Overiť · Spustiť · Audit podpis rola + rozsah pôsobnosti @ info: whatsthis @opsiq/sdk widget dňa ("action. executed") overiť HMAC → rukoväť 200_ OK
3oficiálna SDK: PHP, uzol, Python
HMACSHA-256_ podpísané na každú žiadosť
40+univerzálne udalosti, ktoré sa majú prihlásiť
100%pokrytie auditov v prípade akcií
Životný cyklus žiadosti

Žiadam o pomoc. Podpísaný webhook out.

You post to theOpsIQ APIs tvojím ostrým kľúčom na nosenie.OpsIQkontroluje rozsah a rolu, spúšťa zmluvnú akciu, píše riadok auditu - potom vystrelí HMAC-podpísaný webhok späť do svojho cieľa. Každý hop je overený, nevedomý a retried na zlyhanie.

Webhook HMAC-SHA256 - prichádzajúce a odchádzajúce webhook užitočné zaťaženie sú podpísané cez surové telo; API_ volá autentický s scaped Beader kľúčom.
Automatické spätné odkúpenie - neúspešné dodávky späť a znovu sa skúste, s dodacím dokladom môžete vystopovať.
Kľúče k vhodnosti - opakovaný záznam-bezpečný podľa návrhu, takže znovu skúsený dodávky nikdy dvojité-acts.
Aplikácia POST /v1/actions/run X-OpsIQ-Podpis X-OpsIQ-Timeplamp OVERITE - SPUSTITE - AUDIT Váš koncový ukazovateľ POST /webhooks overiť HMAC 200_ OK overené podpisom rozsah + úloha skontrolovaná Spustenie zmluvnej akcie @ info: whatsthis PAYLOAD Z NAPÄTNEJ PAYLOADOVEJ PAYLOAD { "udalosť": "action. executed" "dodávka_id": "dlv_8f2a9', "idempotencie_key": "idem_31c7', "podpis": "sha256=9c4e0a7b..." } dodaný
01 podpísanú žiadosť 02 overiť HMAC 03 zmluva o spustení 04 riadok pre audit zápisu 05 podpísaný webhook
Rýchly štart

Od nuly k živej integrácii štyri kroky.

Generovať kľúč, vypáliť svoju prvú udalosť, prihlásiť webhok, zaregistrovať akciu. Môžete spustiť celú slučku proti pieskovisku pred dotykom údajov o výrobe.

Piesková konzolaPripojený
DEVELOPER CONSOLE · pieskovisko 1 · Generovať kľúč opq_live_xxx · jeden scaped Beader kľúč 2 · Vyhláste udalosť POST /v1/events/fire "order. shipped" 3 · Prihlásiť sa k odberu webhóok → https://api.you.com/webhooks 4 · Zaregistrujte akciu saas. refund_faktúra · auditovaná
PodporovaťPieskovisko → výroba, rovnaký kód
01

Získať kľúč

Zaregistrujte sa a vygenerujte scaped Beader API kľúč (opq_…) v nastaveniach vývojárov a dať každej integrácii len povrchy, ktoré potrebuje.

02

Páľte & prihlásiť sa

POST a podpísaný events/fire (alebo použite SDK), potom poukážte na akýkoľvek URL v každom prípade, podpísaný, s dodacím číslom a spätnou platnosťou.

03

Zaregistrujte akciu

Vyhláste podpísanú akčnú zmluvu, aby AI mohla bezpečne prevádzkovať operácie s kontrolou úloh, politikou potvrdenia a úplným auditom.

Ako to do seba zapadá

Jeden vzor konektora. Päť čistých primitívov.

Všetko-špecifické platforma žije v konektore. OpsIQ_ jadro zostáva generické, AI zostáva predvídateľné a vaša integrácia zostáva auditovateľné.

01
Spúšťače

PovedzOpsIQčo sa práve stalo.

Vyvolávajte univerzálne udalosti z vašej platformy - alebo si vytvorte vlastné názvy udalostí, na ktoré bude každý účastník reagovať v reálnom čase a podľa poradia priorít.

Odkaz na udalosť
invoice.paid udalosti. oheň [] UI mozogživý kontext pravidlá,Priorita 20 zrkadlonajprv písať webhookpodpísané
Univerzálne + vlastné udalostiinvoice.paid, ticket.created, subscription.cancelled, customer.signed_up alebo tvoj vlastný. Predplatitelia fan-outMozog AI, pravidlá automatizácie, zrkadlové konektory a vaše webové háčky koncové body všetky reagovať. Prioritný príkazDeterministická dispečing, takže zrkadlá písať pred upozornenia požiaru.
02 / Akčné zmluvy

Povedz OpsIQ_ čo môže AI robiť.

Akčná zmluva je podpísané JSON vyhlásenie: čo robí akcia, ktoré role ju môžu spustiť, aké parametre akceptuje, či potvrdenie je potrebné, a koncový ukazovateľ volať.

Schéma akcie
UI nemôže vymyslieť akcieMôže sa len opýtať na tie, ktoré ste zaregistrovali. Potvrdzovacia politikaRiskantné akcie spúšťajú náhľadovú kartu pred akýmkoľvek vedľajším účinkom. Úloha + povrchová výplňKaždá akcia vyhlasuje role a povrchy povolené spustiť.
Akčná zmluva - 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 / Podpísané webhooks

Tlačte udalosti do koša - s kryptografickým dôkazom.

Prihlásiť sa URL_ na každú udalosť. OpsIQ POSTS na JSON užitočné zaťaženie podpísané s HMAC-SHA256 cez surové telo - overiť v niekoľkých riadkoch.

Prehrávanie ochranyVysledovateľné ID doručeniaSpätné väzby
Odkaz na webovú stránku
over 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

Drop-in klienti pre jazyk, ktorý už používate.

Tri oficiálne SDK spracovať autentifikáciu, podpisovanie, retráty, orientačné kľúče a zadané odpovede. Alebo zostať rámec-free - každý SDK je tenký obal okolo rovnakého povrchu REST.

príklady klientov,
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+Uzol. js 18+3.10+REST · OpenAPI 3.0.3
05 / Vzor konektora

Zapojte sa do všetkého.

Konektor je priečinok s jednou triedou PHP. OpsIQ_ objavuje, register prepája udalosti a kód pre konkrétnu platformu zostáva od jadra úplne oddelený.

Sprievodca konektorom
Päť háčikovidentityProviders(), contextProviders(), registerActions(), subscribers(), handleWebhook(). Manifestovanéactions.json a settings.json deklarovať zmluvy a zverejňovať. Automaticky objavenéZapíšte priečinok, podpíšte ho, povoľte ho v admin.
Od zámeru k bezpečnému konaniu

Jasná angličtina. Auditované operácie ukončené.

OpsIQ nikdy nevynájde správny hovor. Prechádza registrovanými zmluvami, pripravuje užitočné zaťaženie, žiada o potvrdenie, kedy si to akcia vyžaduje a vyrobí úplný riadok auditu pri jeho vykonaní, takže AI, ktorá môže akt Nikdy sa nestane UI, ktorým nemôžeš veriť.

Zmluva uzavretá. UI navrhuje len akcie, ktoré ste zaregistrovali.
Pred vedľajšími účinkami to potvrďte. Riskantné akcie povrch náhľad karty ako prvý.
Úplne stiahnuté. Každý rýchly, odpoveď a výsledok akcie zachytený v histórii AI.
4 krokyzámer → audit
HMACpodpísané pred vykonaním
"Návrat Adamovej poslednej faktúry" Krok 1 · riešenie zámerov → matched: saas. refund_faktúra povrch: admin · rola: majiteľ · krok2Potvrdenie Krok 3 · Potvrdiť & znak náhľadová karta · faktúra #8421 Potvrdiť Krok 4 · Riadok auditu herec · prompt · výsledok · 412ms Len vlastník · exportovateľný ako CSV
Žiadne vymyslené hovoryiba zmluvný register
Potvrdenénáhľad pred vedľajšími účinkami
100% auditovanýokamžitá + odpoveď + výsledok
Odkaz

API povrch na prvý pohľad.

Každý základný koncový ukazovateľ, jeho auth, nemennosť a na kľúč limit sadzby. Plná strojovo čitateľná zmluva žije v OpenAPI 3.0.3 referencie.

OpenAPI 3.0.3 referencia
Koncový ukazovateľAutorizáciaIdempotentnéLimit sadzby
ZapísaťPovrchy so zjavným vedľajším účinkom
POST /v1/events/fireHMACÁno1000 / min
POST /v1/actions/runHMACÁno200 / min
POST /v1/webhooks/testHMACÁno60 / min
ČítanieKontext, vstupenky a inventár konektorov
GET /v1/customers/{id}HMACÁno2000 / min
GET /v1/ticketsHMACÁno2000 / min
GET /v1/connectorsHMACÁno2000 / min

Limity sadzieb sú na kľúč a vrátený pri každej odpovedi ako X-OpsIQ-RateLimit-Remaining; prekročenie limitu vrátenia 429 s Retry-After Záhlavie. Plná strojovo čitateľná zmluva (každý koncový ukazovateľ, schéma a chyba) žije v OpenAPI 3.0.3 referencia.

Zostrojiť konektor

Zapojte konektor do päť krokov.

Konektor je samostatný priečinok. OpsIQ_ objavuje, register prepája udalosti a kód pre konkrétnu platformu nikdy neuniká do jadra.

1Rozbaliť priečinok s connector.php predĺženie AbstractConnector.
2Vyhlásenie actions.json a settings.json manifesty.
3Implementovať identitu, kontext a webové stránky poskytovateľov.
4Prihláste sa na udalosti, na ktorých vám záleží.
5Podpíšte to, pustite to, povoľte to v admin.
Test pred loďou

Kľúč od pieskoviska a tester webhhooku.

Každý pracovný priestor odkryje pieskovisko: samostatný scaped kľúč, ktorý zasiahne rovnaký API_ povrch bez dotyku s výrobnými údajmi. POST /v1/webhooks/test vystreliť podpísanú vzorku dodávky na svoj konečný ukazovateľ a potvrdiť si overenie podpisu pred odchodom do živého. Samohostiteľom inštalácie beží rovnakú cestu kódu, bez behaviorálneho posunu medzi cloudom a on-prem.

Kľúče k pieskovisku Tester Webhook Pracovné miesta poháňané kronmi Cloudová a self-hosted parita
konektor. php · php
Trieda AcmeConnector rozšírenia AbstractConnector { verejná funkcia kľúč ((): reťazec { návrat 'acme'; } / Resolve who the herec is verejná funkcia IdentitaPoskytovatelia ((): pole { návrat [nové AcmeIdentityProvider()]; } / / Nasýtenie živých dát do MH verejná funkcia KontextPoskytovatelia ((): pole { návrat [nové AcmeContextProvider()]; } / / Reagovať na OpsIQ_ udalosti verejná funkcia predplatitelia []: pole { návrat ['faktúra. platená' => [nové BillingMirror()]]; } / / Prijímanie prichádzajúce webhooks z Acme verejná funkcia handleWebhook []pole $body): prázdne { /* … */ } }
Ako to porovnáva

OpsIQ vs a DIY integrácia.

Čo zmluvy viazané, podpísaný, auditovaný platforma vám dáva, že valcovanie vlastných webhooks a AI-action inštalatérstvo nikdy nebude.

SchopnosťVytvorte si vlastný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) Vary
Connector pattern: platform code stays isolated
Často kladené otázky

otázky vývojárov, odpovedal.

Auth, podpisy, SDKs, pieskovisko a konektor model: všetko, čo budete pýtať pred prvou žiadosťou.

API volá autentifikovať s jediným scaped Beader kľúčom: odosielať Authorization: Bearer opq_…. OpsIQ kontroluje rozsah a úlohu kľúča pred spustením. Webhooks sú oddelené: každý webhook OpsIQ_ odosiela nesie X-OpsIQ-Signature (hex HMAC-SHA256 surového tela) a X-OpsIQ-Timestamp pre ochranu pre opakované prehrávanie, takže nás môžete overiť na oplátku, a prichádzajúce webhooks, ktoré odošlete sú overené rovnakým spôsobom.
Nie. UI môže navrhnúť iba akcie, ktoré existujú vo vašom registri akcií-zmluvné. Nemôže vymyslieť hovor. Každá zmluva vyhlasuje plochy, role a parametre povolené, a všetky akcie označené requires_confirmation pred začiatkom vedľajšieho účinku sa vystaví náhľadovej karte pre človeka.
Znovu zostaviť hash_hmac('sha256', $rawBody, $secret) (rozptylový trávenie bez predpony) a porovnať s X-OpsIQ-Signature hlavička s nepretržitou kontrolou času (hash_equals). Každá dodávka tiež nesie časovú pečiatku, kľúč nepozornosti a dodacie ID môžete sledovať. PHP snipper na tejto stránke je celé overenie.
Dodávky, ktoré nevrátia 200 sú znovu vyskúšané s exponenciálnym spätným podávaním, z ktorých každá nesie rovnaký kľúč nepozornosti, takže znovu získané dodanie nikdy double-acts. Môžete sledovať každý pokus o doručenie ID v admin alebo svoje záznamy.
Oficiálne SDK pre PHP8.4+, Node.js18+ a Python3.10+ rukoväť podpisovanie, opakovanie, orientácia klávesov a zadané odpovede. Sú to tenké obaly po povrchu REST, takže môžete tiež generovať svojho vlastného klienta z publikovaného OpenAPI3.0.3zmluva alebo hovorAPIpriamo.
Áno. Každá pracovná plocha odkryje pieskovisko s vlastným scaped kľúčom, ktorý zasiahne rovnaký API_ povrch bez dotyku údajov o výrobe, plus POST /v1/webhooks/test vystreliť podpísanú vzorku dodávky na svoj konečný ukazovateľ a potvrdiť svoje overenie pred odchodom do živého.
Áno. Samohostiteľské inštalácie spúšťajú rovnakú cestu kódu (rovnaký podpis, rovnaký register konektorov, rovnaká zmluva OpenAPI), takže medzi cloudom a on-prem nie je žiadny behaviorálny posun.
Konektor je samostatný priečinok s jednou extenzujúcou triedou PHP AbstractConnectorplus actions.json a settings.json manifesty. identityProviders(), contextProviders(), registerActions(), subscribers() a handleWebhook(). OpsIQ _ auto-objaví ho, prepojí udalosti a udržuje si svoj špecifický kód platformy čisto oddelený od jadra.