Entwicklerplattform · REST · Webhooks · SDKs

Machen Sie Ihre Plattform AI-operabel.

OpsIQ stellt eine saubere REST API, HMAC-signierte Webhooks, ein Aktionsvertragsregister und fertige SDKs frei. Definieren Sie, welche Ereignisse von Ihrem System ausgelöst werden, welche Aktionen die KI ausführen darf und welche Daten sicher zu lesen sind. OpsIQ verarbeitet Signaturen, Wiederholungen, Auditprotokolle und Bestätigungsflüsse für Sie.

Holen Sie sich einen API Schlüssel Lesen Sie die Docs SDKs auf GitHub

HMAC-SHA256 beide RichtungenPHP · Node · Python-EntwicklungstoolsOpenAPI 3.0.3 Vertrag100% Audit-Abdeckung

Unterzeichnete Anfrage in

Signierter Webhook out → 200 OK

Lebend

3Offizielle SDKs: PHP, Node, Python

HMACSHA-256 bei jeder Anfrage unterschrieben

40+Universal Events zu abonnieren

100%Erfassung der Auditprotokolle über die Maßnahmen

Der Request Lifecycle

Einholen. Webhook out signiert.

Sie posten den OpsIQ__API mit Ihrem Scoped Bearer-Schlüssel. OpsIQ prüft Umfang und Rolle, führt die vertraglich vereinbarte Aktion aus, schreibt eine Audit-Zeile - und feuert dann einen HMAC-signierten Webhook zurück zu Ihrem Endpunkt. Jeder Hop wird authentifiziert, idempotent und beim Ausfall versucht.

HMAC-SHA256 Webhooks - Ein- und ausgehende Webhook-Nutzlasten werden über den Rohkörper signiert; API ruft sich mit einem Scoped Bearer-Schlüssel authentifizieren.

Automatische Versuchsreihen - fehlgeschlagene Lieferungen zurück und erneut versuchen, mit einer Liefer-ID, die Sie verfolgen können.

Idempotenzschlüssel - replay-safe by design, so dass eine wiederholte Lieferung niemals doppelte Akte.

01 unterzeichneter Antrag 02 HMAC überprüfen 03 Laufender Vertrag 04 Schreib-Audit-Zeile 05 Unterzeichneter Webhook

Schnellstart

Von null bis zu einer Live-Integration in vier Stufen.

Generieren Sie einen Schlüssel, feuern Sie Ihr erstes Ereignis an, abonnieren Sie einen Webhook, registrieren Sie eine Aktion. Sie können die gesamte Schleife gegen die Sandbox laufen lassen, bevor Sie Produktionsdaten berühren.

Sandbox-KonsoleVerbunden

PromotSandbox → Produktion, gleicher Code

Holen Sie sich einen Schlüssel

Melden Sie sich an und erzeugen Sie einen Scoped Bearer API Schlüssel (in Englisch)opq_…) in Entwicklereinstellungen, und geben Sie jeder Integration nur die Oberflächen, die sie benötigt.

Fire & Subscription

POST a signiert events/fire (oder verwenden Sie eine SDK), dann zeigen Sie auf jeden Fall eine URL mit einer Liefer-ID und Back-Off-Retries.

Registrieren einer Aktion

Erklären Sie einen unterzeichneten Aktionsvertrag, damit die KI Operationen sicher ausführen kann, mit Rollenüberprüfungen, Bestätigungsrichtlinien und einem vollständigen Audit-Trail.

Wie es zusammenpasst

Ein Steckverbindermuster. Fünf saubere Primitive.

Alles, was plattformspezifisch ist, lebt in einem Connector. Der OpsIQ-Kern bleibt generisch, die KI bleibt vorhersehbar und Ihre Integration bleibt auditierbar.

Trigger

Sagen Sie OpsIQ, was gerade passiert ist.

Löschen Sie universelle Ereignisse von Ihrer Plattform - oder Ihren eigenen benutzerdefinierten Ereignisnamen. Jeder Abonnent reagiert in Echtzeit, in der Reihenfolge der Priorität.

Datum des Ereignisses

Universal + Custom Eventsinvoice.paid, ticket.created, subscription.cancelled, customer.signed_up oder Ihre eigene. Fan-Out-AbonnentenDas KI-Gehirn, Automatisierungsregeln, Spiegelsteckverbinder und Ihre Webhook-Endpunkte reagieren alle. RangfolgeDeterministischer Versand, so dass Spiegel vor Alarmen Feuer schreiben.

02/ Aktionsverträge

Sagen Sie OpsIQ, was die KI tun darf.

Ein Aktionsvertrag ist eine signierte JSON-Erklärung: Was die Aktion tut, welche Rollen sie ausführen können, welche Parameter sie akzeptiert, ob eine Bestätigung erforderlich ist und der Endpunkt, den sie aufrufen soll.

Aktionsschema

Die KI kann keine Aktionen erfindenEs kann nur darum bitten, diejenigen zu führen, die Sie registriert haben. BestätigungsrichtlinienRiskante Aktionen lösen eine Vorschaukarte vor jeglichem Nebeneffekt aus. Rolle und OberflächenverzahnungJede Aktion erklärt die Rollen und Oberflächen, die erlaubt sind, sie auszuführen.

Aktionsvertrag - 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 / Signierte Webhooks

Push-Events auf Ihren Stack - mit kryptographischen Beweis.

Abonnieren Sie jede URL für jedes Ereignis. OpsIQ POSTet die JSON-Nutzlast, die mit HMAC-SHA256 über den Rohkörper signiert ist - überprüfen Sie es in ein paar Zeilen.

WiedergabeschutzKennung der rückverfolgbaren LieferungBack-off-Retries

Referenznummer des Netzhakens

Verifizieren Sie 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/SDKs

Drop-in-Clients für die Sprache, die Sie bereits verwenden.

Drei offizielle SDKs behandeln Authentifizierung, Signierung, Wiederholungen, idempotency Schlüssel und typisierte Antworten. Oder bleiben Sie Framework-frei - jeder SDK ist eine dünne Verpackung um die gleiche REST-Oberfläche.

Kundenbeispiele

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 / Das Steckermuster

Einmal bauen. Stecken Sie sich in alles ein.

Ein Connector ist ein Ordner mit einer PHP-Klasse. OpsIQ findet ihn, die Registry verdrahtet die Ereignisse und Ihr plattformspezifischer Code bleibt sauber vom Kern getrennt.

Steckverbinderführung

5 HakenidentityProviders(), contextProviders(), registerActions(), subscribers(), handleWebhook(). Manifestgetriebenactions.json und settings.json Verträge und config erklären. Auto-entdecktLegen Sie den Ordner ein, unterschreiben Sie ihn, aktivieren Sie ihn im Admin.

Von der Absicht zum sicheren Handeln

Einfaches Englisch in. Audited Operation Out.

OpsIQ erfindet nie den richtigen Aufruf. Es geht durch die registrierten Verträge, bereitet die Nutzlast vor, fragt nach Bestätigung, wenn die Aktion es erfordert, und erzeugt eine vollständige Audit-Zeile, wenn es ausgeführt wird, also eine KI, die Akt wird nie zu einer KI, der man nicht vertrauen kann.

Kontraktgebunden. Die KI schlägt nur Aktionen vor, die Sie registriert haben.

Bestätigen Sie vor Nebenwirkungen. Riskante Aktionen tauchen zuerst eine Vorschaukarte auf.

Totaler Rückruf. Jede Aufforderung, Antwort und Aktion Ergebnis in AI History erfasst.

Siehe Aktionsschema

4SchritteAbsicht: Audit

HMACUnterzeichnet vor der Ausführung

Keine erfundenen Anrufenur Vertragsregister

BestätigtVorschau vor Nebenwirkungen

100% auditiertprompt + Antwort + Ergebnis

Bezugsnummer

APIOberfläche Auf einen Blick.

Jeder Kernendpunkt, seine Auth-, Idempotenz- und Per-Key-Rate-Limit. Der vollständige maschinenlesbare Vertrag lebt in der OpenAPI 3.0.3 Referenz.

OpenAPI 3.0.3Referenz

EndpunktAuthentienIdempotentZinsbeschränkung

SchreibeSignierte Nebenwirkungsflächen

POST /v1/events/fireHMACJa1000/min

POST /v1/actions/runHMACJa200/min

POST /v1/webhooks/testHMACJa60/min

LesenKontext, Tickets und Connector Inventar

GET /v1/customers/{id}HMACJa2000/min

GET /v1/ticketsHMACJa2000/min

GET /v1/connectorsHMACJa2000/min

Preislimits sind pro Schlüssel und werden bei jeder Antwort als X-OpsIQ-RateLimit-Remaining; Überschreiten einer Limit-Return 429 mit einem Retry-After Der vollständige maschinenlesbare Vertrag (jeder Endpunkt, Schema und Fehler) lebt im OpenAPI 3.0.3Referenz.

Bauen Sie einen Connector

Einen Connector ins Land schicken fünf Stufen.

Ein Connector ist ein in sich geschlossener Ordner. OpsIQ entdeckt ihn, die Registry verdrahtet die Ereignisse und Ihr plattformspezifischer Code sickert nie in den Kern.

1Gerüst ein Ordner mit connector.php sich erstreckend AbstractConnector.

2Anmeldung actions.json und settings.json Manifeste.

3Implementieren Sie Identitäts-, Kontext- und Webhook-Anbieter.

4Abonnieren Sie die Ereignisse, die Ihnen wichtig sind.

5Unterschreiben, einfügen, im Admin aktivieren.

Testen Sie, bevor Sie versenden

Ein Sandbox-Schlüssel und ein Webhook-Tester.

Jeder Arbeitsbereich stellt eine Sandbox frei: eine separate Scope-Taste, die auf dieselbe API-Oberfläche trifft, ohne Produktionsdaten zu berühren. POST /v1/webhooks/test um eine signierte Musterlieferung an Ihrem Endpunkt auszulösen und Ihre Signaturverifizierung zu bestätigen, bevor Sie live gehen. Selbst gehostete Installationen führen den gleichen Codepfad aus, ohne Verhaltensdrift zwischen Cloud und On-Prem.

Sandboxschlüssel Webhook-Tester Cron-getriebene Jobs Cloud & Self-Hosting Parity

Steckverbinderführung Referenznummer des Netzhakens

connector. php · php

Klasse AcmeConnector erstreckt sich AbstractConnector { öffentliche Funktion Schlüssel(): String { Rücklauf „acme; } // Beschließen, wer der Schauspieler ist öffentliche Funktion Identitätsprovider (): Array { Rücklauf [neu AcmeIdentityProvider()]; } // Live-Daten in die AI-Eingabeaufforderung einspeisen öffentliche Funktion Verwendung von contextProviders(): Array { Rücklauf [neu AcmeContextProvider()]; } // Reagieren Sie auf OpsIQ Ereignisse öffentliche Funktion Abonnenten(): Array { Rücklauf ["invoice. paid" => [neu BillingMirror()]]; } // Erhalten Sie eingehende Webhooks von Acme öffentliche Funktion handleWebhook()Array $body): leere { /* … */ } }

⚖️ Wie es verglichen wird

OpsIQvs. a DIY Integration.

Was für eine vertragsgebundene, unterzeichnete, geprüfte Plattform Ihnen bietet, dass das Rollen Ihrer eigenen Webhooks und AI-Action-Klebeinstallation niemals wird.

Leistungsfähigkeit	Roll Your Own	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)	Sorten	✓
Connector pattern: platform code stays isolated	—	✓

FAQ

Entwicklerfragen, beantwortet.

Auth, Signaturen, SDKs, Sandboxing und das Steckermodell: alles, was Sie vor der ersten Anfrage fragen.

API ruft mit einem einzigen Scoped Bearer-Schlüssel authentifiziert auf: senden Authorization: Bearer opq_…. OpsIQ prüft den Umfang des Schlüssels und die Rolle des Schauspielers, bevor etwas läuft. Webhooks sind getrennt: jeder Webhook OpsIQ sendet einen X-OpsIQ-Signature (ein hex HMAC-SHA256 des Rohkörpers) und ein X-OpsIQ-Timestamp für den Wiederspielschutz, damit Sie uns im Gegenzug überprüfen können und eingehende Webhooks, die Sie senden, auf die gleiche Weise verifiziert werden.

Nein. Die KI kann nur Aktionen vorschlagen, die in Ihrem Aktionsvertragsregister vorhanden sind. Sie kann keinen Aufruf erfinden. Jeder Vertrag erklärt die Oberflächen, Rollen und Parameter, die erlaubt sind, und jede Aktion markiert requires_confirmation Oberflächen eine Vorschaukarte zu einem Menschen, bevor der Nebeneffekt läuft.

Recalcute hash_hmac('sha256', $rawBody, $secret) (ein Hex Digest ohne Präfix) und vergleichen Sie es mit dem X-OpsIQ-Signature Header mit konstanter Zeitkontrolle ()hash_equalsJede Lieferung trägt auch einen Zeitstempel, einen idempotency Schlüssel und eine Lieferung ID, die Sie verfolgen können.

Lieferungen, die keine 200 zurückgeben, werden mit exponentiellem Back-Off wiederholt, wobei jede den gleichen idempotency-Schlüssel trägt, so dass eine wiederholte Lieferung niemals doppelte Akte enthält.

Offizielle SDKs für PHP 8.4+, Node. js 18+ und Python 3.10+ behandeln Signierung, Wiederholungen, idempotency-Schlüssel und typisierte Antworten. Sie sind dünne Wrapper um die REST-Oberfläche, so dass Sie auch Ihren eigenen Client aus dem veröffentlichten OpenAPI 3.0.3 Vertrag generieren oder den API direkt aufrufen können.

Ja. Jeder Arbeitsbereich stellt eine Sandbox mit einem eigenen Scope-Key frei, der auf die gleiche API-Oberfläche trifft, ohne Produktionsdaten zu berühren, plus POST /v1/webhooks/test um eine signierte Musterlieferung an Ihrem Endpunkt auszulösen und Ihre Bestätigung zu bestätigen, bevor Sie live gehen.

Selbst gehostete Installationen führen den identischen Codepfad aus (die gleiche Signatur, die gleiche Connector-Registrierung, derselbe OpenAPI-Vertrag), so dass es keine Verhaltensdrift zwischen Cloud und On-Prem gibt.

Ein Connector ist ein in sich geschlossener Ordner mit einer PHP-Klasse, die sich erstreckt AbstractConnector, plus actions.json und settings.json Manifeste. Sie implementieren identityProviders(), contextProviders(), registerActions(), subscribers() und handleWebhook(). OpsIQ entdeckt es automatisch, verkabelt die Ereignisse und hält Ihren plattformspezifischen Code sauber vom Kern getrennt.