Πλατφόρμα προγραμματιστή · REST · webhooks · SDKs

Κάντε την πλατφόρμα σας - ΑΙ-χειροπρακτικό.

OpsIQ εκθέτει ένα καθαρό RESTAPI, HMAC-υπογεγραμμένες webhooks, ένα μητρώο με σύμβαση δράσης και έτοιμο σε πλοίο SDKs. Καθορίστε ποια γεγονότα φωτιά από το σύστημά σας, ποιες ενέργειες επιτρέπεται να τρέξει η AI, και τι δεδομένα είναι ασφαλές να διαβάσει.OpsIQ χειρίζεται τις υπογραφές, τις retries, τα αρχεία καταγραφής ελέγχου και τις ροές επιβεβαίωσης για εσάς.

HMAC-SHA256 και οι δύο τρόποιPHP · κόμβος · SDKs PythonΣύμβαση OpenAPI 3.0.3100% κάλυψη του ελέγχου
Υπογραφή της αίτησης
Υπογραφή webhook out →200 Εντάξει.
Ζωντανά curl → OpsIQ → υπογεγραμμένο webhook POST /v1/actions/run Χ...OpsIQ-Υπογραφή. { "action": ⁇ επιστροφή_τιμολόγιο ⁇ Επιβεβαιώθηκε ⁇ : αλήθεια } VERIFY · RUN · ΕΛΕΓΧΟΣ υπογραφή ⁇ ⁇ όλων + πεδίου εφαρμογής ⁇ Γράφτηκε σειρά ελέγχου @opsiq/sdk γραφικό συστατικό on( ⁇ action. executed ⁇ (Έκτευξη της δράσης) επαλήθευση HMAC → λαβή 200 Εντάξει.
3επίσημα SDKs: PHP, κόμβος, Python
HMAC (ΗΠΑΚ)ΣΧΑ-256 υπογεγραμμένη σε κάθε αίτηση
40+καθολικά γεγονότα για εγγραφή
100%κάλυψη του λογιστικού ελέγχου για δράσεις
Ο κύκλος ζωής του αιτήματος

Αιτούμαι. Υπέγραψε το webhook.

Εσύ θα πας στοOpsIQ API με το τηλεσκόπιο σου.OpsIQ έλεγχο του πεδίου εφαρμογής και του ρόλου, τρέχει τη συμβατική δράση, γράφει μια σειρά ελέγχου - τότε πυροβολεί ένα HMAC-υπογεγραμμένο webhook πίσω στο τελικό σημείο σας.

HMAC-SHA256 webhooks (στα Αγγλικά) - τα εισερχόμενα και εξερχόμενα ωφέλιμο φορτίο του webhook υπογράφονται πάνω από το ωμό σώμα,API καλεί αυθεντικότητα με ένα τηλεκατευθυνόμενο κλειδί.
Αυτόματες επαναφορτίσεις - απέτυχε παραδόσεις πίσω μακριά και να προσπαθήσουμε, με μια ταυτότητα παράδοσης μπορείτε να εντοπίσετε.
Κλειδί indempotency - replay-ασφαλής από το σχεδιασμό, έτσι ώστε μια retried παράδοση ποτέ δεν διπλοπράγματα.
Η εφαρμογή σας POST /v1/actions/run Χ...OpsIQ-Υπογραφή. X-_OpsIQ-Χρονογραφημένη ετικέτα VERIFY - RUN - ΕΛΕΓΧΟΣ Το τελικό σημείο σου POST /webhooks επαλήθευση HMAC 200 Εντάξει. επαληθεύτηκε υπογραφή πεδίο εφαρμογής + έλεγχος ⁇ όλων συμβατική εκτέλεση δράσης Γράφτηκε σειρά ελέγχου Υπογεγραμμένη ΠΑΙΧΝΙΔΙΑ WEBHOok { ⁇ Γεγονός: ⁇ ενεργός.εκτελεστικός ⁇ ⁇ Παράδοση_id ⁇: ⁇ dlv_8f2a9 ⁇ ⁇ αδυναμία_κλειδί: ⁇ ιδέμ_31γ7 ⁇ ⁇ υπογραφή ⁇: "sha256=9γ4ε0α7β..." } Παραδίδεται
01 υπογεγραμμένη αίτηση 02 επαλήθευση HMAC 03 σύμβαση εκτέλεσης 04 εγγραφή γραμμής ελέγχου 05 υπογεγραμμένο webhook
Γρήγορη εκκίνηση

Από το μηδέν σε μια ζωντανή ενσωμάτωση στο Τέσσερα βήματα.

Δημιουργία ενός κλειδιού, πυρ κατά την πρώτη σας εκδήλωση, εγγραφή σε ένα webhook, εγγραφή μιας ενέργειας. Μπορείτε να εκτελέσετε όλο το βρόχο ενάντια στο sandbox πριν αγγίξετε τα δεδομένα παραγωγής.

κονσόλα SandboxΣυνδεδεμένο
ΑΝΑΒΑΛΕΡΟΠΡΟΚΟΛΕ · αμμοκουτί 1 · Δημιουργία κλειδιού opq_live_xxx · ένα πλήκτρο σκόπευσης 2· Φωτιά σε ένα γεγονός ΠΟΣΤΟ/v1/events/fire⁇ Παραγγελία, αποστολή ⁇ 3 · Εγγραφείτε σε ένα webhook → https://api.you.com/webhooks 4 · Καταχωρήστε μια ενέργεια saas. refund_invoice · ελέγχθηκε
ΠροώθησηSandbox → παραγωγή, ίδιος κωδικός
01

Πάρε ένα κλειδί.

Εγγραφείτε και δημιουργήστε έναν προγραμματιζόμενο κομιστήAPI κλειδί (opq_…) στις ρυθμίσεις του προγραμματιστή και δίνουν σε κάθε ολοκλήρωση μόνο τις επιφάνειες που χρειάζεται.

02

Πυροδότηση & εγγραφή

POST ένα υπογεγραμμένο events/fire (ή χρήσηSDK) και στη συνέχεια να υποδείξειURL σε κάθε περίπτωση, υπογεγραμμένη, με ταυτότητα παράδοσης και εφεδρικές επαναφορτίσεις.

03

Εγγραφή μιας ενέργειας

Δηλώστε υπογεγραμμένη σύμβαση δράσης, ώστε η AI να μπορεί να εκτελεί με ασφάλεια τις λειτουργίες, με ελέγχους ⁇ όλων, πολιτική επιβεβαίωσης και πλήρη διαδρομή ελέγχου.

Πως ταιριάζει μεταξύ τους

Ένα μοτίβο σύνδεσης. Πέντε καθαροί πρωτόγονοι.

Οτιδήποτε συγκεκριμένο στην πλατφόρμα ζει σε ένα συνδετήρα.OpsIQ Ο πυρήνας παραμένει γενικός, η τεχνητή νοημοσύνη παραμένει προβλέψιμη και η ενσωμάτωσή σας παραμένει ελέγξιμη.

01
Ενεργοποιητές

Πες το.OpsIQ Τι συνέβη μόλις τώρα.

Πυροδότησε καθολικά γεγονότα από την πλατφόρμα σου - ή τα δικά σου προσαρμοσμένα ονόματα γεγονότων.

Αναφορά γεγονότος
invoice.paid events. fire() Εγκεφαλική AIζωντανό πλαίσιο κανόνεςπροτεραιότητα 20 καθρέπτηςΓράφω πρώτα webhook (φύλλο ιστού)υπογεγραμμένη
Καθολικές + προσαρμοσμένες εκδηλώσειςinvoice.paid, ticket.created, subscription.cancelled, customer.signed_up Ή το δικό σου. Συνδρομητές Fan-outΟ εγκέφαλος της τεχνητής νοημοσύνης, οι κανόνες αυτοματοποίησης, οι σύνδεσμοι καθρεφτών και τα τελικά σημεία webhook σας όλα αντιδρούν. Σειρά προτεραιότηταςΑποφασιστική αποστολή έτσι καθρέφτες γράφουν πριν ειδοποιήσει φωτιά.
02/ Συμβάσεις δράσης

Πες το.OpsIQ Τι επιτρέπεται να κάνει η τεχνητή νοημοσύνη.

Μια σύμβαση δράσης είναι μια υπογεγραμμένη δήλωση JSON_: τι κάνει η ενέργεια, ποιοι ρόλοι μπορούν να το εκτελέσουν, ποιες παραμέτρους δέχεται, αν απαιτείται επιβεβαίωση, και το τελικό σημείο για να καλέσετε.

Σχήμα δράσης
Η τεχνητή νοημοσύνη δεν μπορεί να εφεύρει πράξεις.Μπορεί να ζητήσει μόνο να τρέξει αυτά που έχετε καταχωρήσει. Πολιτική επιβεβαίωσηςΟι επικίνδυνες ενέργειες ενεργοποιούν μια κάρτα προεπισκόπησης πριν από οποιαδήποτε παρενέργεια. Ρόλος + επιφανειακό επίστρωμαΚάθε ενέργεια δηλώνει τους ρόλους και τις επιφάνειες που επιτρέπεται να το εκτελέσουν.
Σύμβαση δράσης -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/ Υπογεγραμμένα webhooks

Σπρώξτε τα γεγονότα στο σωρό σας - με κρυπτογραφική απόδειξη.

Εγγραφή σε οποιοδήποτεURL σε κάθε γεγονός.OpsIQΠΟΣΤΟJSON ωφέλιμο φορτίο υπογεγραμμένο με HMAC-SHA256 πάνω από το ωμό σώμα - το επαληθεύστε σε μερικές γραμμές.

Προστασία επανάληψηςΑναγνωριστικό παράδοσηςΕπαναστάσεις εκ νέου λειτουργίας
Αναφορά webhook
επαλήθευση 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

Να αποσυνδέσετε πελάτες για τη γλώσσα που ήδη χρησιμοποιείτε.

Τρία επίσημα SDKs χειρίζονται την ταυτοποίηση, την υπογραφή, τις ρετρίς, τα πλήκτρα idempotency και δακτυλογραφημένες απαντήσεις. Ή μείνετε χωρίς πλαίσιο - κάθε SDK είναι ένα λεπτό περιτύλιγμα γύρω από την ίδια επιφάνεια REST.

παραδείγματα πελατών
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+Κόμβος.js18+Πάιθον3.10+ΑΝΑΤΟΛΙΣΜΟΣ · OpenAPI 3.0.3
05/ Το μοτίβο σύνδεσης

Φτιάξε μια φορά, σύνδεσε τα πάντα.

Ένας συνδετήρας είναι ένας φάκελος με μία PHP κλάση. OpsIQ το ανακαλύπτει, το μητρώο καλωδιώνουν τα γεγονότα, και ο κωδικός σας που αφορά την πλατφόρμα παραμένει καθαρά χωρισμένος από τον πυρήνα.

Οδηγός σύνδεσης
Πέντε άγκιστραidentityProviders(), contextProviders(), registerActions(), subscribers(), handleWebhook(). Με βάση το πρότυποactions.json και settings.json να δηλώσουν συμβάσεις και να συνάψουν συμφωνίες. Αυτόματο-ανακαλύπτεταιΡίξτε το φάκελο μέσα, υπογράψτε το, ενεργοποιήστε το στο admin.
Από πρόθεση σε ασφαλή δράση

Απλά αγγλικά μέσα. Η ελεγκτική επιχείρηση τελείωσε.

OpsIQ δεν εφευρίσκει ποτέ τη σωστή κλήση. Περπατά μέσα από τα καταχωρημένα συμβόλαια, προετοιμάζει το ωφέλιμο φορτίο, ζητά επιβεβαίωση όταν η ενέργεια το απαιτεί, και παράγει μια πλήρη σειρά ελέγχου όταν εκτελεί, έτσι ώστε μια AI που μπορεί να πράξη Ποτέ δεν γίνεται μια Αλ που δεν μπορείς να εμπιστευτείς.

- Συμβόλαιο. Η τεχνητή νοημοσύνη προτείνει μόνο τις ενέργειες που έχετε καταχωρήσει.
Επιβεβαιώστε πριν τις παρενέργειες. Οι επικίνδυνες ενέργειες εμφανίζονται πρώτα σε μια κάρτα προεπισκόπησης.
Πλήρης ανάκληση. Κάθε άμεση, αντίδραση και δράση έχει ως αποτέλεσμα την AI History.
4 βήματαπρόθεση → έλεγχος
HMAC (ΗΠΑΚ)υπογεγραμμένη πριν από την εκτέλεση
⁇ επιστροφή του τελευταίου τιμολογίου του Άνταμ ⁇ Βήμα 1 · επίλυση πρόθεσης → ταιριαστό: saas. refund_invoice επιφάνεια: admin · ρόλος: ιδιοκτήτης · Βήμα2 επικύρωση Βήμα 3 · Επιβεβαίωση & υπογραφή κάρτα προεπισκόπησης · τιμολόγιο #8421 Επιβεβαίωση Βήμα 4 · Σειρά ελέγχου ηθοποιός · άμεση · αποτέλεσμα ·412ms Ιδιοκτήτης μόνο · εξάγεται ωςCSV
Δεν επινοήθηκαν κλήσεις.μόνο μητρώο σύμβασης
Επιβεβαιώνεται η πύληπροεπισκόπηση πριν από τις παρενέργειες
100%Ελεγμένοςάμεση + απόκριση + αποτέλεσμα
Βάση

API επιφάνεια Με μια ματιά.

Κάθε τελικό σημείο πυρήνα, η auth, η ιδεοδυναμία και το όριο ανά συντελεστή-κλειδί.3.0.3 αναφορά.

OpenAPI3.0.3 παραπομπή
Τελικό σημείοΑυθΙδιόμορφοΌριο τιμών
ΕγγραφήΕπιφάνειες με υπογραφή
POST /v1/events/fireHMAC (ΗΠΑΚ)Ναι.1000/ min
POST /v1/actions/runHMAC (ΗΠΑΚ)Ναι.200/ min
POST /v1/webhooks/testHMAC (ΗΠΑΚ)Ναι.60/ min
ΑνάγνωσηΠλαίσιο, κατάλογο εισιτηρίων και συνδέσεων
GET /v1/customers/{id}HMAC (ΗΠΑΚ)Ναι.2000/ min
GET /v1/ticketsHMAC (ΗΠΑΚ)Ναι.2000/ min
GET /v1/connectorsHMAC (ΗΠΑΚ)Ναι.2000/ min

Τα όρια τιμών είναι ανά κλειδί και επιστρέφονται σε κάθε απάντηση, όπως X-OpsIQ-RateLimit-Remaining— που υπερβαίνει τα όρια αποδόσεων 429 με α Retry-After κεφαλίδα. Η πλήρης σύμβαση που μπορεί να αναγνώσιμο μηχάνημα (κάθε τελικό σημείο, σχήμα και λάθος) ζει στο OpenAPI3.0.3 παραπομπή.

Κατασκευή ενός συνδετήρα

Πλοίο σύνδεσης Πέντε βήματα.

Ένας σύνδεσμος είναι ένας αυτοτελής φάκελος. OpsIQ_ τον ανακαλύπτει, το μητρώο καλωδώνει τα γεγονότα, και ο κώδικας σας-συγκεκριμένος πλατφόρμας δεν διαρρέει ποτέ στον πυρήνα.

1Αναδίπλωση ενός φακέλου με connector.php επέκταση AbstractConnector.
2Δηλώστε actions.json και settings.json Δηλώσεις.
3Εφαρμογή παρόχων ταυτότητας, πλαισίου και webhook.
4Εγγραφείτε στα γεγονότα που σας ενδιαφέρουν.
5Υπόγραψε, πέτα το μέσα, ενεργοποίησε το στο admin.
Δοκιμή πριν από το πλοίο

Ένα κλειδί και ένα δοκιμαστή.

Κάθε χώρος εργασίας εκθέτει ένα sandbox: ένα ξεχωριστό πλήκτρο που χτυπά το ίδιοAPI επιφάνεια χωρίς να αγγίζουν τα δεδομένα παραγωγής. POST /v1/webhooks/test να πυροδοτήσει μια υπογεγραμμένη παράδοση δείγματος στο τελικό σημείο σας και να επιβεβαιώσει την επαλήθευση υπογραφής σας πριν από τη μετάβαση ζωντανά. Αυτο-φιλοξενούμενες εγκαταστάσεις τρέχει την ίδια διαδρομή κώδικα, χωρίς συμπεριφορική μετατόπιση μεταξύ σύννεφου και on-prem.

Κλειδιά Sandbox Ελεγκτής webhook Εργασίες με βάση το Cron Σύννεφο & αυτο-ξεναγμένη ισοτιμία
connector. php · php
κλάση ΑκμήConnector επέκταση AbstractConnector { δημόσια λειτουργία κλειδί (): συμβολοσειρά { επιστροφή \"Άκμη\"; } // Επίλυση ποιος είναι ο ηθοποιός δημόσια λειτουργία Αναγνωριστικοί φορείς(): συστοιχία { επιστροφή [νέο AcmeIdentityProvider()]; } // Τροφοδοτήστε ζωντανά δεδομένα στην AI προτροπή δημόσια λειτουργία frameProviders(): συστοιχία { επιστροφή [νέο AcmeContextProvider()]; } // Αντιδράτε σεOpsIQ συμβάντα δημόσια λειτουργία συνδρομητές(): συστοιχία { επιστροφή [\"Φόρος. Πληρωμένο\" => [νέο BillingMirror()]]; } // Λήψη εισερχόμενων webhooks από το Acme δημόσια λειτουργία ΧειρισμόςWebhook(συστοιχία $body): κενό { /* … */ } }
⁇ Πώς συγκρίνεται

OpsIQvs α DIY ενσωμάτωση.

Τι συμβόλαιο, υπογεγραμμένη, ελεγχόμενη πλατφόρμα σου δίνει ότι το να τραβάς τα δικά σου δικτυωτά και τα υδραυλικά AI-action δεν θα το κάνουν ποτέ.

ΙκανότηταΓύρνα το δικό σου.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) Βάρη
Connector pattern: platform code stays isolated
Συχνές ερωτήσεις

Ερωτήσεις προγραμματιστή, Απάντησε.

Όθ, υπογραφές, SDKs, sandboxing και το μοντέλο σύνδεσης: όλα όσα θα ζητήσετε πριν από την πρώτη αίτηση.

API Επικύρωση κλήσεων με ένα μόνο πλήκτρο scoped Bearer: αποστολή Authorization: Bearer opq_…. OpsIQ ελέγχει το εύρος του κλειδιού και το ρόλο του ηθοποιού πριν από οτιδήποτε τρέχει.OpsIQ στέλνει φέρει ένα X-OpsIQ-Signature (a HMAC-SHA256 του ακατέργαστου σώματος) και X-OpsIQ-Timestamp για την προστασία επανάληψης, ώστε να μπορείτε να μας επαληθεύσετε σε αντάλλαγμα, και εισερχόμενα webhooks που στέλνετε επαληθεύονται με τον ίδιο τρόπο.
Όχι. Η AI μπορεί να προτείνει μόνο ενέργειες που υπάρχουν στο μητρώο σας για τη σύμβαση δράσης. Δεν μπορεί να εφεύρει μια κλήση. Κάθε σύμβαση δηλώνει τις επιφάνειες, τους ρόλους και τις παραμέτρους που επιτρέπονται, και κάθε ενέργεια που σημειώνεται requires_confirmation επικαλύπτει μια κάρτα προεπισκόπησης σε έναν άνθρωπο πριν από την παρενέργεια τρέχει.
Επαναφορά hash_hmac('sha256', $rawBody, $secret) (μια χωνεμένη κόγχη χωρίς πρόθεμα) και να το συγκρίνουν με το X-OpsIQ-Signature κεφαλίδα με έλεγχο συνεχούς χρόνου (hash_equals. Κάθε παράδοση φέρει επίσης ένα χρονόμετρο, ένα κλειδί idempotency και ένα ID παράδοσης μπορείτε να εντοπίσετε.
Παραδόσεις που δεν επιστρέφουν200 έχουν δοκιμαστεί με εκθετική back-off, καθένα από τα οποία φέρει το ίδιο κλειδί idempotency έτσι μια retried παράδοση ποτέ δεν διπλές πράξεις. Μπορείτε να εντοπίσετε κάθε προσπάθεια από την ταυτότητα παράδοσης σε admin ή τα αρχεία καταγραφής σας.
Επίσημα SDK για PHP8.4+, κόμβος.js18+ και Python3.10+ Χειρίζονται την υπογραφή, retries, τα κλειδιά idempotency και δακτυλογραφημένες απαντήσεις. Είναι λεπτά περιτυλίγματα γύρω από την επιφάνεια REST, έτσι μπορείτε επίσης να δημιουργήσετε το δικό σας πελάτη από το δημοσιευμένο OpenAPI3.0.3 σύμβαση ή να καλέσετε τοAPI άμεσα.
Κάθε χώρος εργασίας εκθέτει ένα αμμόκουτο με το δικό του τηλεσκόπιο κλειδί που χτυπά το ίδιοAPI επιφάνεια χωρίς επαφή με δεδομένα παραγωγής, συν POST /v1/webhooks/test να απολύσετε ένα υπογεγραμμένο δείγμα παράδοσης στο τελικό σημείο σας και να επιβεβαιώσετε την επαλήθευση σας πριν πάτε ζωντανά.
Ναι. Οι αυτο-φιλοξενούμενες εγκαταστάσεις εκτελούν την ίδια διαδρομή κώδικα (την ίδια υπογραφή, το ίδιο μητρώο σύνδεσης, το ίδιο συμβόλαιο OpenAPI) ώστε να μην υπάρχει συμπεριφορική μετατόπιση μεταξύ σύννεφου και on-prem.
Ένας συνδετήρας είναι ένας αυτοτελής φάκελος με μία PHP κλάση επέκτασης AbstractConnector, συν actions.json και settings.json δηλωτικά. Μπορείτε να υλοποιήσετε identityProviders(), contextProviders(), registerActions(), subscribers() και handleWebhook(). OpsIQ Το ανακαλύπτει αυτόματα, καλωδώνει τα γεγονότα και διατηρεί τον κωδικό πλατφόρμας σας καθαρά χωρισμένο από τον πυρήνα.