Fejlesztő platform · REST · webhorog · SDK

A platform létrehozása - Az AI- operálható.

A OpsIQ egy tiszta REST API, HMAC- dedikált webhorog, egy akció- szerződés regisztere és a hajó SDK-k. Definiáld, hogy milyen események tüzelnek a rendszeredből, milyen cselekvések futhatnak le az MI-n, és milyen adatok olvashatók el biztonságosan. A OpsIQ kezeli az aláírásokat, reléket, ellenőrzési naplót és visszaigazoló áramlást az Ön számára.

HMAC- SHA256 mindkét iránybanPHP · Node · Python SDKOpenAPI 3.0.3 szerződés100% ellenőrzési lefedettség
Aláírt kérelem:
Aláírt webhorog → 200 OK
Élő curl → OpsIQ → aláírt webhorog POST /v1/actions/run X- OpsIQ- Aláírás { "action": "visszatérítés _ számla", "megerősítve": igaz ELLENŐRZÉS aláírás szerep- és hatókör Az ellenőrzés sorát írásba kell foglalni. @opsiq/sdkwidget ("action . execution") check HMAC → fogantyú 200 OK
3hivatalos SDK-k: PHP, Node, Python
HMACSHA- 256 minden kérésre aláírva
40+az előfizetésre váró egyetemes események
100%Az ellenőrzési-naplózási lefedettség a cselekvések esetében
A kérelem életciklusa

Kérés. Aláírt webhorog.

- Te vagy a főnök.OpsIQ APIA te optikailag bearer kulcsoddal.OpsIQellenőrzi a hatókört és a szerepet, lefuttatja a szerződést, ír egy auditsort - majd kilő egy HMAC-aláírással ellátott webhorog vissza a végpontot. Minden hop hitelesítve, idempotens és újra kipróbálják a hiba.

HMAC- SHA256 horog - a bejövő és kimenő webhorog terhelések aláírásával a nyers test felett; API hívások hitelesítése egy opcionális Bearer kulccsal.
Automatikus retrika - sikertelen szállítások vissza, és újra, egy szállítási azonosító lehet lenyomozni.
Idempotencia billentyűk - újratervezve, a biztonság kedvéért, szóval egy újraindítás nem dupla felvonás.
Az alkalmazás POST /v1/actions/run X- OpsIQ- Aláírás X...OpsIQ- Időbélyeg A CRR 429. cikke (1) bekezdésének b) pontja A végpont POST /webhooks a HMAC ellenőrzése 200 OK aláírás hitelesítve hatály + a szerepellenőrzés szerződéses művelet Az ellenőrzés sorát írásba kell foglalni. Aláírt webook { "esemény": "action. executed", "location _ id": "dlv _ 8f2a9", "idempotence _ key": "idem _ 31c7", "aláírás": "sha256 =9c4e0a7b..." } leszállított
01 aláírt kérelem 02 a HMAC ellenőrzése 03 A szerződés időtartama 04 a könyvvizsgálati sor írása 05 dedikált webhorog
Gyorsindítás

A nullától az élő integrációig 4 lépés.

Létrehozhatsz egy kulcsot, elsütheted az első eseményt, feliratkozhatsz egy webhorog-ra, regisztrálhatsz egy műveletet. Az egész hurkot a homokozóba futtathatod, mielőtt a gyártási adatokhoz érnél.

Homokdoboz konzolCsatlakozás
FEJLESZTŐ KONSOLE · homokozó 1 · Kulcs létrehozása opq _ live _ xxx · egy képletű Bearer kulcs 2 POST /v1/events/fire "render. shipped" 3 Feliratkozás egy webhorog → https://api.you.com/webhooks 4· Regisztrálj egy akciót saas. visszatérítés _ számla · ellenőrzött
ElőléptetésHomokdoboz → gyártás, ugyanaz a kód
01

Szerezz kulcsot!

Regisztráljon be és generáljon egy opciós Bearer API gombot (opq_…) fejlesztői beállításokban, és minden egyes integráció csak a felületek szükséges.

02

Tűz & előfizetés

A POST aláírása events/fire (vagy használja aSDK), majd a pont bármelyURLminden esetben, aláírva, szállítólevéllel és visszaváltással.

03

A kereset nyilvántartásba vétele

Aláírt cselekvési szerződés, amely lehetővé teszi a MI-k számára, hogy biztonságosan működjenek, szerepellenőrzésekkel, megerősítési politikával és teljes ellenőrzési nyomvonalzal.

Hogy illeszkedik össze

Egy csatlakozóminta. Öt tiszta primitívet.

Bármi, ami platformspecifikus, egy csatlakozóban él. A OpsIQ mag általános marad, a MI kiszámítható, és az integrációd ellenőrizhető marad.

01
Eseményindítók

Mondja el a OpsIQ-nak, mi történt.

Tűz univerzális események a platform - vagy a saját egyedi esemény nevek. Minden előfizető reagál valós időben, prioritási sorrendben.

A dokumentum hivatkozási száma
invoice.paid események. Tűz () AI agyélő környezet szabályok20 prioritás tükörÍrj először. horogaláírt
Univerzális + egyéni eseményekinvoice.paid, ticket.created, subscription.cancelled, customer.signed_up Vagy a sajátodat. Fan- out előfizetőkAz MI agy, automatizálási szabályok, tükrös csatlakozók és a webhorog végpontok mind reagálnak. Prioritási sorrendDeterminista feladás, így a tükrök írni, mielőtt a riasztások tüzet.
02 / Akciószerződések

Mondja el a OpsIQ-nak, hogy mit tehet az MI.

A cselekvési szerződés egy aláírt JSON nyilatkozat: mit tesz a cselekvés, mely szerepeket tud futtatni, milyen paramétereket fogad el, szükség van-e megerősítésre, és a végpontot kell hívni.

Műveleti séma
Az MI nem találhat ki tetteket.Csak a regisztrált példányokat kérheti. Megerősítési politikaKockázatos tevékenységek indítanak előnézeti kártyát, mielőtt bármilyen mellékhatást. A szerepkör + a felületi kapuzárásMinden művelet kijelenti, hogy a szerepek és felületek lehetővé teszik a futását.
Akciószerződés - 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 / Aláírt webhorog

Nyomja események a stack - kriptográfiai bizonyíték.

Feliratkozás bármilyenURLMinden eseményre.OpsIQPOSTJSONa HMAC- SHA256-al aláírt hasznos teher a nyers test felett - ellenőrizze néhány sorban.

A visszaforgatás védelmeNyomon követhető szállítási azonosítóHátrameneti relék
Webhorog hivatkozás
check 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

A már használt nyelvért az ügyfeleknél.

Három hivatalos SDK kezeli hitelesítés, aláírás, relikvencia, idempotencia billentyűk és gépelt válaszok. Vagy maradjon framwork-mentes - mindenSDKegy vékony csomagolás ugyanazon REST felület körül.

Ügyfél-példák
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 +3.0.3 - A szolgáltatások elérhetősége
05 / A csatlakozó mintázata

Építs egyet, és dugj bele mindent.

A csatlakozó egy PHP-s mappa. A OpsIQ felfedezi, a regiszteren keresztül irányítja az eseményeket, és a platformspecifikus kódod teljesen elkülönül a magtól.

Kapcsolattartó
Öt horgot.identityProviders(), contextProviders(), registerActions(), subscribers(), handleWebhook(). Manifeszt-vezéreltactions.json és settings.json A szerződés és a konfig bejelentése. Auto-felfedezettDobd be a mappát, írd alá, és engedd adminba.
A szándéktól a biztonságos cselekvésig

Egyszerű angol. Ellenőrzött művelet.

OpsIQsoha nem találja fel a megfelelő hívást. Átsétál a regisztrált szerződések, előkészíti a hasznos teher, kéri a megerősítést, amikor a cselekvés megköveteli, és létrehoz egy teljes ellenőrzési sor, amikor végrehajtja, így egy AI, hogy cselekvés Soha nem lesz olyan MI, akiben nem bízhatsz.

- Kötött szerződés. Az MI csak olyan tetteket javasol, amiket regisztráltál.
Megerősítve a mellékhatások előtt. Kockázatos tevékenységek felülete egy előnézeti kártya először.
Teljes visszaemlékezés. Minden azonnali, válasz- és akcióeredmény, amit az MI történelmében rögzítettek.
4 lépésekSzándék → ellenőrzés
HMACa végrehajtás előtt aláírva
"Adam utolsó számláját". Lépés 1 · szándékbontás → egyezés: saas. visszatérítés _ számla felület: admin · szerep: tulajdonos · lépés 2 érvényesség Lépés 3 · Erősítse meg és írja alá Előnézeti kártya · számla # 8421 Megerősítés Lépés4· Ellenőrzési sor színész, azonnali eredmény, 412ms Tulajdonos: csak exportálható, mint CSV
Nincs feltalált híváskizárólag a szerződés-jegyzék
Megerősítveelőnézet a mellékhatások előtt
A 100% ellenőrzéseazonnali + válasz + eredmény
Hivatkozás

API felület Egy pillanat.

Minden fő végpont, annak authot, idempotencia és per- key kamatláb limit. A teljes gépi olvasható szerződés él az OpenAPI 3.0.3 hivatkozás.

OpenAPI 3.0.3 hivatkozás
VégpontAuthIdemotensA kamatláb határa
Írj!Jelzett oldalirányú felületek
POST /v1/events/fireHMACIgen.1000 / perc
POST /v1/actions/runHMACIgen.200 / perc
POST /v1/webhooks/testHMACIgen.60 / perc
Olvassa elKontextus, jegyek és csatlakozó leltár
GET /v1/customers/{id}HMACIgen.2000 / perc
GET /v1/ticketsHMACIgen.2000 / perc
GET /v1/connectorsHMACIgen.2000 / perc

A kamatlábhatárok kulcsonként vannak, és minden válaszra visszatérnek, X-OpsIQ-RateLimit-Remaining; túllépi a limit-hozamot 429 a Retry-After Fejléc. A teljes gépi olvasható szerződés (minden végpont, séma és hiba) él a OpenAPI 3.0.3 hivatkozás.

Csatlakozó építése

Hajó csatlakozó Öt lépés.

A csatlakozó egy önálló mappa. OpsIQ felfedi, a regiszterben drót az események, és a platformspecifikus kód soha nem szivárog a magba.

1Scaffold egy mappa connector.php meghosszabbítás AbstractConnector.
2deklaráció actions.json és settings.json A manifesztek.
3A személyazonosság, a kontextus és a webhorog szolgáltatóinak végrehajtása.
4Iratkozz fel azokra az eseményekre, amik fontosak neked.
5Írd alá, dobd be, és engedd be az adminisztrációba.
Teszt a hajó előtt

Egy homokdoboz kulcs és egy horog tesztelő.

Minden munkaterület homokozót mutat: egy külön, a API felületre ható opciós kulcsot, a gyártási adatok érintése nélkül. POST /v1/webhooks/test hogy tűz egy aláírt minta szállítás a végponton, és erősítse meg az aláírás ellenőrzése előtt élő. Self- hosted installs fut az azonos kódút, anélkül, hogy viselkedési sodródás felhő és on-prem.

Homokdoboz billentyűk Webhorog tesztelő Kronikus munkahelyek Felhő és önkiszolgáló paritás
connector. php · php
osztály AcceConnector kiterjesztések AbstractConnector { közfeladat kulcs (): sztring { visszatérés "acme"; } / / Oldja meg, hogy ki a színész közfeladat A szolgáltatóknak (): tömb { visszatérés [új AcmeIdentityProvider()]; } / / Élő adatok betáplálása a AI-s gyorshangba közfeladat contextProviderek (): tömb { visszatérés [új AcmeContextProvider()]; } / / React to OpsIQ events közfeladat előfizetők (): tömb { visszatérés ["invoice. paid" => [új BillingMirror()]]; } / / Fogadja a bejövő webhorog Acme közfeladat handleWebhook (tömb $body): üres { /* … */ } }
- Hogy hasonlítható össze?

OpsIQ vs egy DIY integráció.

Amit egy szerződéskötéses, aláírt, ellenőrzött platform ad, az a saját webhorog és az AI- akciós vízvezeték gördítése soha nem fog.

KépességTekerje a sajátjátOpsIQ
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) Megváltozások
Connector pattern: platform code stays isolated
GYIK

Fejlesztői kérdések, Válaszolt.

Auth, aláírások, SDK, sandbox és a csatlakozó modell: mindent, amit az első kérés előtt kérni fogsz.

API hívások hitelesítése egyetlen képletű Bearer kulcs: küldés Authorization: Bearer opq_…. OpsIQ ellenőrzi a kulcs hatókörét és a színész szerepét, mielőtt bármi fut. Webhook külön: minden webhorog OpsIQ küld egy X-OpsIQ-Signature (a nyers test hex HMAC- SHA256 törzse) és X-OpsIQ-Timestamp a visszajátszás védelem, így ellenőrizni minket cserébe, és bejövő webhorog küldesz azonos módon.
Nem. Az MI csak a cselekvés- szerződés regisztrációjában létező intézkedéseket javasolhat, nem találhat fel egy hívást. Minden szerződés tartalmazza a megengedett felületeket, szerepeket és paramétereket, valamint minden olyan intézkedést, amely megjelöli a requires_confirmation Az oldaleffektus előtt egy előnézeti kártyát felhelyez egy emberre.
Rekuta hash_hmac('sha256', $rawBody, $secret) (egy előtag nélküli hexa-emésztődés) és hasonlítsa össze a X-OpsIQ-Signature Fejléc konstans-idő ellenőrzéssel (hash_equals). Minden szállítás tartalmaz egy időbélyegző, egy idempotencia kulcs és egy szállítási azonosító lehet nyomon követni. A PHP snippet ezen az oldalon az egész ellenőrzés.
A 200-t nem visszaadó szállítmányok exponenciális háttérrel kerülnek újra próbára, mindegyik ugyanazt az idempotencia-kulcsot hordozza, így egy újrapróbált szállítás soha nem dupla akciók. Minden kísérlettel nyomon követhető az admin vagy naplók adatátviteli azonosítója.
Hivatalos SDK- k a PHP-hez8.4+, Node.js18+ és Python3.10+ fogantyú aláírás, retry, idempotencia billentyűk és gépelt válaszok. Ezek vékony csomagolások körül a REST felület, így is generálni a saját kliens a közzétett OpenAPI3.0.3szerződés vagy felhívásAPIközvetlenül.
Minden munkaterület egy homokozót mutat ki, saját képletű kulccsal, amely a termelési adatok érintése nélkül eltalálja ugyanazt a API felületet, plusz POST /v1/webhooks/test hogy kilőjön egy aláírt mintát a végpontján, és megerősítse az ellenőrzést, mielőtt élőben megy.
Igen. Az önkiszolgáló telepek azonos kódpályát futnak (azonos aláírás, ugyanaz a csatlakozó regisztráció, ugyanaz az OpenAPI szerződés), így nem változik a viselkedés a felhő és az on-prem között.
A csatlakozó egy önálló mappa egy PHP osztály kiterjesztésével AbstractConnector, plusz actions.json és settings.json manifesztek. identityProviders(), contextProviders(), registerActions(), subscribers() és handleWebhook(). OpsIQ auto-fedi fel, drótozza az eseményeket, és tartja a platformspecifikus kódot tisztán elkülönítve a magtól.