Vývojářská platforma · REST · webháky · SDK

Vytvořte si platformu - Dá se to ovládat.

OpsIQodhaluje čistý odpočinekAPI, HMAC-signed webháky, action-contract registr a ready- to- ship SDK. Definujte, co události oheň z vašeho systému, co akce AI je dovoleno spustit, a jaká data je bezpečné číst.OpsIQzpracovává podpisy, opakování, auditní záznamy a potvrzovací toky pro vás.

HMAC- SHA256 oběma směryPHP · Uzel · Python SDKSmlouva OpenAPI 3.0.3100%pokrytí auditů
Podepsaná žádost v
Podepsaný webhook → 200 OK
Živé curl → OpsIQ → sign. webhook POST /v1/actions/run X-OpsIQ-Podpis { "action": "refund _ fakturace", "potvrzen": pravda} OVĚŘENÍ · SPRÁVA · AUDIT podpis (y) role + rozsah Auditní řádek @ opsiq / sdk widget na ("akce. provedena") ověření HMAC → rukojeť 200 OK
3oficiální SDK: PHP, nód, Python
HMACSHA-256 podepsaný na každou žádost
40+univerzální akce k přihlášení
100%audit- log pokrytí akcí
Celoživotní cyklus žádosti

Žádám o to. Vypnuto.

Vy POST na OpsIQ API s vaším oskenovaným klíčem pro uživatele. OpsIQ kontroluje rozsah a roli, běží smluvně akce, píše řádek auditu - pak vyvolá HMAC- signed webhook zpět do vašeho cílového parametru. Každý hop je ověřen, idempotent a znovu vyzkoušen na selhání.

HMAC- SHA256 webháky - přilétávání a odvíjení výplatních pásů na webu jsou podepsány přes surové tělo; API volá ověřeno s oskenovaným klíčem pro doručitele.
Automatické reverze - neúspěšné dodávky zpět a znovu, s ID doručení můžete sledovat.
Idempotentní klíče - replay- bezpečné podle návrhu, takže znovu vyzkoušené dodání nikdy zdvojnásobit-akty.
Vaše aplikace POST /v1/actions/run X-OpsIQ-Podpis X- OpsIQ-Časový údaj OVĚŘENÍ - RUN - AUDIT Váš cílový parametr POST /webhooks ověřuje HMAC 200 OK Ověřený podpis rozsah + kontrola úlohy smluvní akční běh Auditní řádek ZNÁMÁ PLATBA WEBHOOK { "událost": "akce. "delivery _ id": "dlv _ 8f2a9", "idempotency _ key""idem _ 31c7", "podpis": "sha256 =9c4e0a7b..." } dodané
01 podepsaná žádost 02 ověřuje HMAC 03 smlouva o provozování 04 řádek pro audit zápisu 05 podepsaný webhook
Rychlý start

Od nuly k živé integraci v Čtyři kroky.

Vytvořte klíč, vypalte první událost, přihlaste se k webháku, zaregistrujte akci. Před dotykem s produkčními daty můžete spustit celou smyčku proti pískovišti.

Konzola pískového boxuPřipojeno
ROZVOJOVÁ KONSOLA · pískoviště 1 · Generovat klíč opq _ live _ xxx · jeden klíč pro doručovatele 2 · Vypalte událost POST /v1/events/fire "order. expedted" 3 · Přihlásit se na webhook → https://api.you.com/webhooks 4 · Zaregistrujte se saas. refund _ fakturation · audited
PodporovatPísková krabička → výroba, stejný kód
01

Získat klíč

Zaregistrujte se a generujte skenovaný klíč Nosiče API (opq_…) v nastavení vývojářů, a dát každé integraci pouze povrchy, které potřebuje.

02

Požární a předplatné

POST a podepsaný events/fire (nebo použít SDK), pak bod jakýkoliv URL na každém případě, podepsané, s ID dodávky a back- off retries.

03

Zaregistrujte akci

Vyhlásit podepsanou akční smlouvu, aby mohla AI bezpečně provozovat operace, s kontrolou rolí, potvrzovací politikou a plnou auditní stopou.

Jak to k sobě pasuje

Jeden vzor konektoru. Pět čistých primitivů.

Cokoliv platform- specific žije v konektoru. OpsIQ jádro zůstane obecné, AI zůstane předvídatelné, a vaše integrace zůstane auditovatelná.

01
Spouštěče

Řekni OpsIQ, co se právě stalo.

Požární univerzální akce z vaší platformy - nebo vlastní názvy akcí. Každý účastník reaguje v reálném čase, v pořadí prioritních.

Odkaz na událost
invoice.paid events. fire () AI mozekživý kontext pravidlapriorita 20 zrcadloNejdřív zapište webhookpodepsaný
Univerzální + vlastní akceinvoice.paid, ticket.created, subscription.cancelled, customer.signed_up nebo vlastní. PředplatiteléAI mozek, automatizace pravidel, zrcadlové konektory a váš webhook koncové body všechny reagovat. Prioritní pořadíDeterministické expedice, takže zrcadla napíšou, než se spustí požár.
02 / Akční smlouvy

Řekni OpsIQ, co může AI dělat.

Akční smlouva je podepsané prohlášení JSON: co akce dělá, které role mohou spustit, jaké parametry přijímá, zda je nutné potvrzení a cíl, který má volat.

Akční schéma
AI nemůže vynalézt činy.Může to chtít jen ty, které jste registrovali. Potvrzovací politikaRiskantní akce spustí předváděcí kartu před jakýmkoli vedlejším účinkem. Úloha + povrchové zakrytíKaždá akce prohlašuje, že role a povrchy jsou povoleny k jeho spuštění.
akční smlouva - 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 / Podepsané webové háky

Tlačte události do zásobníku - s kryptografickým důkazem.

Přihlaste se k jakékoli události URL. OpsIQ POSTs JSON užitečné zatížení podepsané HMAC-SHA256 nad surovým tělem - ověřte si to v několika řádcích.

Ochrana před opakovaným přehranímPrůjezdná identifikace dodáníZpětné-off retry
Odkaz na Webhook
ověření webhooku - 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 pro jazyk, který již používáte.

Tři oficiální SDK rukojeť autentizace, podepisování, opakování, idempotency klíče a zadané odpovědi. Nebo zůstat framework- free - každý SDK je tenký obal kolem stejné plochy REST.

Příklady klientů
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 8.4 +Node. js 18 +Python 3.10 +Rest · OpenAPI 3.0.3
05 / Potisk konektoru

Jednou se postavíme, zapojíme se do čehokoliv.

Konektor je složka s jednou třídou PHP. OpsIQ ji objeví, registr navede události a váš platform- specifický kód zůstane čistě oddělen od jádra.

Průvodce konektorem
Pět háčkůidentityProviders(), contextProviders(), registerActions(), subscribers(), handleWebhook(). Manifest- drivedactions.json a settings.json vyhlásit smlouvy a konfigurovat. Automaticky objevenZahoďte složku, podepište ji, zapněte ji admin.
Od záměru k bezpečnému jednání

- Je to v angličtině. Auditovaná operace.

OpsIQ nikdy nevynalezne správné volání. Prochází registrovanými smlouvami, připravuje užitečné zatížení, žádá o potvrzení, když to akce vyžaduje, a vytváří kompletní řádek auditu, když provádí, takže AI, který může akt Nikdy se nestane AI, které nemůžeš věřit.

- Svazuje se na kontrakt. AI navrhuje jen akce, které jste zaregistrovali.
Potvrďte před vedlejšími účinky. Riskantní akce nejprve vystaví kartu náhledu.
Úplně si to vybavuju. Každý rychlý, odezva a akční výsledek zachycený v historii AI.
4 krokyzáměr → audit
HMACPodepsáno před provedením
"Vrátit Adamovu poslední fakturu" Krok 1 · řešení záměru → odpovídající: saas. refund _ faktura povrch: admin · role: majitel · Krok 2 validovat Krok 3 · Potvrzení & podpis náhled karty · faktura # 8421 Potvrdit Krok 4 · Auditní řádek herec · equipment · výsledek · 412ms Pouze majitel- · exportovatelný jako CSV
Žádné vymyšlené hovory.pouze smluvní rejstřík
Konfirmovanénáhled před vedlejšími účinky
100% auditovanýrychlé + odpověď + výsledek
Odkaz

APIpovrch na první pohled.

Každý hlavní cílový parametr, jeho auth, idempotence a per- key limit. Kompletní strojově čitelná smlouva žije v OpenAPI 3.0.3 referenci.

OpenAPI 3.0.3 reference
Koncový bodAuthCity in New York USAIdempotenceMezní hodnota
ZapsatPodepsané boční plochy
POST /v1/events/fireHMACAno.1000 / min
POST /v1/actions/runHMACAno.200 / min
POST /v1/webhooks/testHMACAno.60 / min
ČtěteKontext, tipy a soupis konektorů
GET /v1/customers/{id}HMACAno.2000 / min
GET /v1/ticketsHMACAno.2000 / min
GET /v1/connectorsHMACAno.2000 / min

Sazby jsou stanoveny na klíč a vráceny na každou odpověď jako X-OpsIQ-RateLimit-Remaining; překročení mezních výnosů 429 s Retry-After záhlaví. Kompletní strojově čitelná smlouva (každý koncový bod, schéma a chyba) žije v OpenAPI 3.0.3 reference.

Vybudovat konektor

Vyšlete konektor v Pět kroků.

Konektor je samostatná složka. OpsIQ ji objeví, registr navede události a váš platform- specifický kód nikdy nepronikne do jádra.

1Vymazat složku s connector.php prodloužení AbstractConnector.
2Vyhlášení actions.json a settings.json - Projevy.
3Provádět identitu, kontext a poskytovatele webháků.
4Přihlaste se k událostem, na kterých vám záleží.
5Podepište to, zahoďte to, povolte to v adminu.
Otestujte před odesláním

Klíč od pískoviště a tester na háček.

Každý pracovní prostor vystavuje pískoviště: samostatný klíč s osférou, který zasáhne stejný povrch API, aniž by se dotkl výrobních dat. POST /v1/webhooks/test k vypálení podepsaného vzorku dodávky na váš cílový bod a potvrdit ověření podpisu před zapnutím. Self- hosted instals spustit identický kód cestu, bez chování drift mezi cloud a on- prem.

Klíče od pískoviště Tester Webhook Pracovní místa poháněná korunami Parita cloud & self-hosted
konektor. php · php
třída AcmeConnector Rozšíření AbstractConnector { veřejná funkce klíč (): řetězec { návrat "acme"; } / / Vyřešte, kdo je ten herec veřejná funkce identifityProviders (): pole { návrat [nový AcmeIdentityProvider()]; } / / Předat data živě do AI příhodu veřejná funkce contextProviders (): pole { návrat [nový AcmeContextProvider()]; } / / React to OpsIQ events veřejná funkce Účastníci (): pole { návrat ["fakturace. paid" => [nový BillingMirror()]]; } / / Přijímáme přilétající webháky z Acme veřejná funkce handleWebhook (pole $body): neplatné { /* … */ } }
Jak to srovnává

OpsIQ vs a Integrace DIY.

Co kontrakt-vázat, podepsal, auditované platforma vám dává, že válení své vlastní webháky a AI- akce instalatérství nikdy nebude.

SchopnostVytvořte 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) Liší se
Connector pattern: platform code stays isolated
Často kladené otázky

Otázky vývojářů, Ano.

Auth, podpisy, SDK, pískování a konektor model: vše, co budete žádat před prvním požadavkem.

API hovory ověřené jedním skenovaným klíčem pro doručovatele: odeslat Authorization: Bearer opq_…. OpsIQ kontroluje rozsah klíče a role herce před tím, než něco běží. Webháky jsou oddělené: každý webháček OpsIQ posílá nese X-OpsIQ-Signature (zákal HMAC- SHA256 surového těla) a X-OpsIQ-Timestamp pro ochranu před přehráváním, takže nás můžete ověřit na oplátku, a přilétají webové háčky, které posíláte, jsou ověřeny stejným způsobem.
Ne. AI může navrhnout pouze akce, které existují ve vašem registru akcesmluv. Nemůže vynalézt hovor. Každá smlouva prohlašuje povrchy, role a parametry povoleny, a jakékoli akce označené requires_confirmation na povrchu je předváděcí karta k člověku před bočním efektem běží.
Rekombinovat hash_hmac('sha256', $rawBody, $secret) a porovnejte je s X-OpsIQ-Signature záhlaví s kontrolou konstantního času (hash_equals). Každá dodávka má také časové razítko, idempotency klíč a ID doručení, které můžete sledovat. Úryvek PHP na této stránce je celé ověření.
Dodávky, které nevrací 200 jsou znovu vyzkoušeny s exponenciální back- off, každý nese stejný idempotency klíč, takže retestované dodání nikdy double- acts. Můžete sledovat každý pokus o doručení ID v admin nebo vaše protokoly.
Oficiální SDK pro PHP 8.4 +, Node. js 18 + a Python 3.10 + handsigning, retry, idempotency kláves a zapisované odpovědi. Jsou tenké obaly kolem povrchu REST, takže můžete také generovat svého klienta ze zveřejněné smlouvy OpenAPI 3.0.3 nebo volat API přímo.
Ano. Každý pracovní prostor vystavuje pískoviště s vlastním oskenovaným klíčem, který zasáhne stejný povrch API bez doteku výrobních dat, plus POST /v1/webhooks/test k vypálení podepsané dodávky vzorku ve vašem cílovém parametru a potvrzení ověření před tím, než budete pokračovat v přímém přenosu.
Ano. Self- hostované instalace běží identickou cestu kódu (stejné podepisování, stejný seznam konektorů, stejná smlouva OpenAPI), takže neexistuje žádný posun chování mezi cloudem a on- prem.
Konektor je samostatná složka s jedním rozšiřujícím se PHP třídou AbstractConnector, plus actions.json a settings.json Projevy. Implementujete identityProviders(), contextProviders(), registerActions(), subscribers() a handleWebhook(). OpsIQ auto- objeví, převede události a udržuje váš platform- specifický kód čistě oddělený od jádra.