Kehittäjä alusta · REST · webhooks · SDKs

Tee alustasta Tekoälyä voidaan käyttää.

OpsIQ paljastaa puhtaan REST API, HMAC-allekirjoitetut webkoukkuja, toiminta-sopimusrekisterin ja valmis-alukseen SDKs. Määrittele mitä tapahtumia tulipalosta järjestelmästäsi, mitä toimia tekoälyllä saa ajaa, ja mitä tietoja on turvallista lukea. OpsIQ käsittelee allekirjoituksia, korjauksia, tarkastuslokit ja vahvistusvirrat sinulle.

HMAC-SHA256 molempiin suuntiinPHP · Node · Python-ohjelmistokehityspaketitOpenAPI 3.0.3 sopimus100%auditoinnin kattavuus
Allekirjoitus
Allekirjoitettu webhook out →200 Hyvä on.
Elävät curl → OpsIQ → allekirjoitettu webkook POST /v1/actions/run X-OpsIQ- Allekirjoittaminen { "action": 'refund_invoice' "Varmistan": totta } VERIFY · KÄYT• TARKASTUS Allekirjoitus ... rooli + soveltamisala ... tilintarkastusrivi @opsiq/sdkelementti ["toiminta. toteutettu") tarkistaa HMAC → kahva 200 Hyvä on.
3Viralliset SDK:t: PHP, Node, Python
HMACSHA.256 allekirjoitettu jokaisessa pyynnössä
40+tilattavat yleiset tapahtumat
100%Toimien audit-log-kattavuus
Pyynnön kesto

Pyydän sisään. -Signeerattu webkoopa.

POST-palveluunOpsIQ APITarkkaavaimellasi.OpsIQ Tarkistaa laajuus ja rooli, suorittaa sopimuksen toiminta, kirjoittaa tarkastusrivin - sitten ampua HMAC-allekirjoitettu webkoukku takaisin päätepiste. Jokainen hyppy on todennettu, idemopotentti ja yritetään uudelleen epäonnistuminen.

HMAC-SHA256 webkoukkua - saapuvat ja lähtevät webkoukku hyötykuormat on allekirjoitettu yli raa'an kehonAPIsoittoäänet ovat aitoja, ja niillä on tarkkailtu Karhu-avain.
Automaattiset uudelleenkäsittelyt - Epäonnistuneet toimitukset peruvat ja yrittävät uudelleen.
Idemponency avaimet - Toistan, joten nouto ei ole koskaan kaksoisnäytös.
Sovelluksenne POST /v1/actions/run X-OpsIQ- Allekirjoittaminen X-OpsIQ- Aikaleima VERIFY - KÄY - TARKASTUS Sinun päätetapahtumasi POST /webhooks tarkistaa HMAC 200 Hyvä on. allekirjoitus todennettu soveltamisala + tehtävä tarkastettu Sopimusten mukainen toiminta tilintarkastusrivi ALLEKIRJOITETTU KESKUSPANKKI { 'tapahtumalla': "toiminta. toteutettu," "toimitus_tunnus": 'dlv_8f2a9', 'idempotency_key': 'idem_31c7', 'allekirjoitus': "sha256=9c4e0a7b..." } toimitettu
01 allekirjoitettu pyyntö 02 tarkistaa HMAC 03 Juokseva sopimus 04 kirjaustarkastusrivi 05 allekirjoitettu webkoukku
Pikakäynnistys

Nollasta live-integraatioon Neljä askelta.

Luo avain, ammu ensimmäinen tapahtuma, tilaa webkoukku, rekisteröi toiminto. Voit ajaa koko silmukan vastaan hiekkalaatikko ennen kuin kosketat tuotantotietoja.

HiekkalaatikkokonsoliYhdistetty
DEVEROLE · hiekkalaatikko 1· Luo avain opq_live_xx · yksi tarkennettu Karjan avain 2· Tulta tapahtuma POST /v1/events/fire "order. shiped" 3· Tilaa webkoukku → https://api.you.com/webhooks 4· Rekisteröi toimi sas. refund_invoice · audited
EdistääHiekkalaatikko → tuotanto, sama koodi
01

Hae avain.

Rekisteröidy ja luo tähystetty karhuAPI avain (opq_…) kehittäjän asetukset, ja antaa jokaiselle integraatio vain pinnat se tarvitsee.

02

Tulipalotilaus

POST allekirjoitettava events/fire (tai käytäSDK), sitten kohta tahansaURL Allekirjoitettuna, mukana toimituksen tunniste ja varauloskirjaukset.

03

Rekisteröi toimi

Ilmoita allekirjoitettu toimintasopimus, jotta tekoäly voi suorittaa turvallisesti toimintoja, joissa on tehtävätarkastuksia, vahvistuskäytäntö ja täydellinen kirjausketju.

Miten se sopii yhteen

Yksi liitinkuvio. Viisi puhdasta alkuasukasta.

Kaikki alustakohtainen elää liittimessä.OpsIQ Ydin pysyy geneerisenä, tekoäly pysyy ennustettavana ja integraatio pysyy tarkastettavissa.

01
Liipaisimet

Kerro OpsIQ_ mitä juuri tapahtui.

Tulipalo yleistapahtumia alustalta - tai omia mukautettuja tapahtumanimiä. Jokainen tilaaja reagoi reaaliajassa, tärkeysjärjestyksessä.

Tapahtuman viite
invoice.paid events. fire() Tekoälylive-ympäristö säännötprioriteetti 20 peiliKirjoita ensin webkookkiallekirjoitettu
Universaalit ja mukautetut tapahtumatinvoice.paid, ticket.created, subscription.cancelled, customer.signed_up Tai sinun. LannoitustilaajatTekoälyn aivot, automaatiosäännöt, peililiittimet ja webkoukkusi päätepisteet reagoivat. Etusijainen järjestysMäärittelevä lähetys, joten peilit kirjoittavat ennen hälytystä.
02 / Toimintasopimukset

Kerro OpsIQ_ mitä tekoälyllä on lupa tehdä.

Toimintasopimus on allekirjoitettu JSON ilmoitus: mitä toimi tekee, mitkä roolit voivat ajaa sitä, mitä parametreja se hyväksyy, onko vahvistus vaaditaan, ja päätepiste soittaa.

Toimintakaavio
Tekoäly ei osaa keksiä tekoja.Se voi pyytää vain rekisteröityjä. VahvistuspolitiikkaRiskienhallinta laukaisee esikatselukortin ennen sivuvaikutusta. Rooli + pinta-aitaJokainen toiminta ilmoittaa roolit ja pinnat sallittu ajaa sitä.
toimintasopimus - 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 / Allekirjoitetut verkkokoukkuja

Työnnä tapahtumia pino - salaus todiste.

TilaaURL mihin tahansa.OpsIQ PostitusJSONHMAC-SHA256:n kanssa tehty hyötykuorma - varmista se muutamalla viivalla.

Toista suojausJäljitettävissä oleva toimitustunnusVaratoimet
Webkookin viite
todentaa webkoukku - 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

Pudotat asiakkaita käyttämällesi kielelle.

Kolme virallista SDK:ta käsittelee tunnistautumista, allekirjoitusta, uusintaa, idemponency-avaimia ja kirjoitettuja vastauksia.SDKon ohut kääre saman REST-pinnan ympärillä.

asiakasesimerkkejä
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+3.10+3.0.3
05/ Liittimen kuvio

-Ei, vaan näppäile.

Yhdistäminen on kansio, jossa on yksi PHP-luokka. OpsIQ löytää sen, rekisteri johdottaa tapahtumat ja alustakohtainen koodi pysyy puhtaana erillään ytimestä.

Liitosopas
Viisi koukkuaidentityProviders(), contextProviders(), registerActions(), subscribers(), handleWebhook(). Manifestivetoisetactions.json sekä settings.json ilmoittaa sopimukset ja config. Automaattinen löytyminenPudota kansio sisään, allekirjoita se, ota se käyttöön admin.
Aikomuksesta turvalliseen toimintaan

-En. - Tarkastettu operaatio.

OpsIQ ei koskaan keksi oikeaa puhelua. Se kulkee rekisteröityjen sopimusten läpi, valmistelee hyötykuorman, pyytää vahvistusta, kun toimi vaatii sitä, ja tuottaa täydellisen tarkastusrivin, kun se suorittaa, joten tekoäly, joka voi säädös -Ei sinusta tule tekoälyä.

- Sopimus tehty. Tekoäly ehdottaa vain rekisteröimiäsi toimia.
Vahvista ennen sivuvaikutuksia. Riskienhallinta on ensin esikatselukortti.
Täysin muistan. Jokainen nopea, vastaus ja toiminta johtaa vangittu tekoälyn historia.
4 askeletaie → tilintarkastus
HMACallekirjoitettu ennen suoritusta
"palauta Adamin viimeinen lasku" Askel1· aieratkaisu → täsmää: saas. refund_invoice pinta: admin · rooli: omistaja · askel2 validoi Askel3· Vahvista & merkki esikatselukortti · lasku #8421 Vahvista Askel4· Tarkastusrivi näyttelijä · prompt · result · 412ms Omistaja vain · viedäänCSV
Ei keksitty puhelujaainoastaan sopimusrekisteri
Vahvistettuesikatselu ennen sivuvaikutuksia
100% tarkastettunopea + vaste + tulos
Viite

API pinta -Ei, vaan silmäyksellä.

Jokainen päätapahtuma, sen auth, idempotency ja per-avain korkoraja. Täysi koneluettava sopimus elää OpenAPI 3.0.3 reference.

OpenAPI3.0.3 viite
PäätetapahtumaAutIdempotenttiKorkoraja
KirjoitaAllekirjoitetut sivuvaikutukset
POST /v1/events/fireHMACKyllä1000/ min
POST /v1/actions/runHMACKyllä200/ min
POST /v1/webhooks/testHMACKyllä60/ min
LueKonteksti, liput ja liitinluettelo
GET /v1/customers/{id}HMACKyllä2000/ min
GET /v1/ticketsHMACKyllä2000/ min
GET /v1/connectorsHMACKyllä2000/ min

Rate raja on avainta kohti ja palautetaan jokaisen vastauksen X-OpsIQ-RateLimit-Remaining; raja-arvojen ylittäminen 429 jossa Retry-After otsikko. Koko koneluettava sopimus (jokainen päätepiste, skeema ja virhe) elää OpenAPI3.0.3 viite.

Koosta liitin

Lähetä liitin sisään Viisi askelta.

Liitos on itsenäinen kansio. OpsIQ löytää sen, rekisteri johdottaa tapahtumat, ja alustakohtainen koodi ei koskaan vuoda ytimeen.

1Skaffold kansio connector.php Laajennetaan AbstractConnector.
2Julista actions.json sekä settings.json -Ei.
3Toteutetaan identiteetti-, konteksti- ja verkkokoostutuspalvelujen tarjoajat.
4Tilaa ne tapahtumat, joista välität.
5Allekirjoita, pudota se sisään, ota se käyttöön.
Kokeile ennen kuin lähetät

Hiekkalaatikon avain ja webkookintesteri.

Jokainen työtila paljastaa hiekkalaatikon: erillinen tähystetty avain, joka osuu samaanAPI pinta koskettamatta tuotantotietoja. POST /v1/webhooks/test ampua allekirjoitettu näyte toimitus päätepiste ja vahvistaa allekirjoitusvarmennus ennen kuin menee suorana. Itseohjatut asennukset ajaa identtinen koodi polku, ilman käyttäytyminen ajelehtii pilvi ja on-prem.

Hiekkalaatikon avaimet Webkookin testaaja Cron-vetoiset työpaikat Pilvi- ja itse isännöidyt pariteettiarvot
liitin. php · php
luokka AcmeConnector Laajennukset AbstractConnector { julkinen tehtävä avain(): merkkijono { palautus 'akme'; } / / Selvitä kuka näyttelijä on julkinen tehtävä henkilöllisyyttä tarjoavat henkilöt(): matriisi { palautus [uusi AcmeIdentityProvider()]; } // Syötä elävää tietoa tekoälykehottimeen julkinen tehtävä kontekstipalveluntarjoajat(): matriisi { palautus [uusi AcmeContextProvider()]; } / / ReactOpsIQ tapahtumat julkinen tehtävä tilaajat(): matriisi { palautus ["lasku. maksettu" => [uusi BillingMirror()]]; } / / Vastaanottaa saapuvat webkoukkuja Acme julkinen tehtävä kahvaWebhook(matriisi $body): mitätön { /* … */ } }
...

OpsIQvs - DIY-kotoutuminen.

Mitä sopimus sitova, allekirjoitettu, tarkastettu alusta antaa sinulle, että kääriminen omia webkoukkuja ja tekoäly-toiminta putkistot koskaan.

VoimavaraPyöritä omaasiOpsIQ
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) Vaihtelee
Connector pattern: platform code stays isolated
UKK

Kehittäjän kysymykset Vastasit.

Auth, allekirjoitukset, SDK, hiekkalaatikko ja liitin malli: kaikki mitä pyydät ennen ensimmäistä pyyntöä.

APIpuhelut todentaa yhdellä soppettu Bearer avain: lähetä Authorization: Bearer opq_…. OpsIQ Tarkista avainten laajuus ja näyttelijän rooli ennen kuin mikään toimii. Webkookit ovat erillisiä: jokainen webkookkiOpsIQ lähetyksissä on X-OpsIQ-Signature (raaka-aineen HMAC-SHA256 -heksa) ja X-OpsIQ-Timestamp uusintasuojauksen, jotta voit vahvistaa meidät vastineeksi, ja saapuvat webkoukkuja lähetät tarkistetaan samalla tavalla.
Ei. Tekoäly voi vain ehdottaa toimia, jotka ovat olemassa toiminta-sopimusrekisterissäsi. Se ei voi keksiä puhelua. Jokainen sopimus ilmoittaa pinnat, roolit ja parametrit sallittu, ja kaikki toimet merkitty requires_confirmation pinnat esikatselukortin ihmiselle ennen sivuvaikutus toimii.
Täytä hash_hmac('sha256', $rawBody, $secret) (kirous sulaa ilman etuliitettä) ja verrata sitä X-OpsIQ-Signature otsikko, jossa on vakioaikatarkastus (hash_equals) Joka toimituksessa on myös aikaleima, idempotency-avain ja toimitustunnus, jonka voit jäljittää. PHP snippet tällä sivulla on koko vahvistus.
Toimitukset, jotka eivät palauta 200 ovat retried exponential back-off, jokainen kuljettaa samaa idempotency avain niin takaisin toimitus koskaan kaksinkertainen-acts. Voit jäljittää jokaisen yrityksen toimitus ID admin tai loki.
PHP:n viralliset SDK:t8.4+, Node.js18+ ja Python3.10+ kahva allekirjoittaminen, retries, idemponency avaimet ja kirjoittanut vastauksia. Ne ovat ohut kääreitä ympäri REST pintaa, joten voit myös luoda oman asiakkaansa julkaistu OpenAPI3.0.3 sopimus tai soittaaAPI Suoraan.
Jokainen työtila paljastaa hiekkalaatikon, jolla on oma tarkistettu avain, joka osuu samaanAPI pinta koskettamatta tuotantotietoja, plus POST /v1/webhooks/test -Entä jos et ole?
Kyllä. Itse isännöidyt asennustyöt ajavat identtistä koodipolkua (sama allekirjoitus, sama liitinrekisteri, sama OpenAPI-sopimus), joten ei ole mitään käyttäytymisen ajelehtimista pilven ja on-premin välillä.
Yhdistäminen on itsenäinen kansio, jossa on yksi PHP-luokka. AbstractConnector, plus actions.json sekä settings.json Manifestit. Toteutat identityProviders(), contextProviders(), registerActions(), subscribers() sekä handleWebhook(). OpsIQ auto-löytää sen, johdottaa tapahtumat ja pitää alustakohtainen koodisi puhtaana erillään ytimestä.