Programu ya Developer · REST · webhooks · SDKs

Fanya jukwaa yako ya utendaji.

OpsIQ inaonyesha REST safi API, HMAC-signed webhooks, Usajili wa mkataba wa utekelezaji na SDKs ya tayari-kwa-ushirika. fafanua ni matukio gani moto kutoka kwa mfumo wako, ni vitendo gani AI inaruhusiwa kuendesha, na data gani ni salama kusoma. OpsIQs inashughulikia saini, retries, kumbukumbu za ukaguzi na mtiririko wa uthibitisho kwako.

Kupata API muhimu Soma zaidi kuhusu docs SDK juu yaGitHub

256 Njia ya KuingilianaWikimedia Commons ina media kuhusu: PythonOpenAPI3.0.3Mkataba wa mkataba100%Taarifa ya ukaguzi

Maombi yaliyopokelewa katika

Webhook iliyosainiwa nje → 200 OK

Maisha ya kuishi

3SDK rasmi: PHP, Node, Python

HMAC yaSHA-256 imesainiwa kwenye kila ombi

40+Matukio ya kimataifa ya kujiandikisha

100%Taarifa ya ukaguzi juu ya vitendo

Maombi ya Lifecycle

Maombi ya kuingia. Bonyeza WEB Ingia.

wewe kutuma kwa ajili yaOpsIQ APIKwa upande wake Meneja wa NMB Bi.OpsIQInaangalia upeo na jukumu, anaendesha hatua ya mkataba, anaandika safu ya ukaguzi - kisha moto mtandao uliosainiwa wa HMAC nyuma ya mwisho wako. Kila hop ni kuthibitishwa, idempotent na retried juu ya kushindwa.

HMAC-SHA256 yahoohooks - Inbound na outbound webhook payloads ni saini juu ya mwili mbichi; API wito kuthibitisha na ufunguo wa Bearer.

Retender ya moja kwa moja - Kushindwa kujifungua mbali na retry, na kitambulisho cha utoaji unaweza kufuatilia.

Vipengele vya msingi - Kurudisha salama kwa kubuni, hivyo utoaji uliorudiwa kamwe mara mbili.

01 Maombi ya 02 Ukaguzi wa HMAC 03 Mkataba wa 04 Kuandika ukaguzi wa hesabu 05 Kujiandikisha kwa Webhook

Haraka ya kuanza

Kutoka 0 hadi Ushirikiano wa Kuishi katika Hatua ya nne.

Kuzalisha ufunguo, moto tukio lako la kwanza, kujiunga na webhook, kujiandikisha hatua. Unaweza kukimbia kitanzi nzima dhidi ya sanduku la mchanga kabla ya kugusa data ya uzalishaji.

Sandbox ya consoleKuunganisha

KukuzaSandbox uzalishaji, kanuni sawa

Kupata ufunguo

Kujiandikisha na kuzalisha Bearer iliyopanuliwaAPIMsingi wa (opq_…) katika mazingira ya msanidi programu, na kutoa kila ushirikiano tu nyuso zinazohitajika.

Jisajili na Jisajili

Barua ya Kusainiwa events/fire (au kutumia SDK), kisha uelekeze URL katika tukio lolote, lililotiwa saini, na kitambulisho cha utoaji na retries za nyuma.

Kujiandikisha kwa hatua

Kutangaza mkataba wa hatua uliosainiwa ili AI iweze kuendesha shughuli kwa usalama, na ukaguzi wa jukumu, sera ya uthibitisho na uchaguzi kamili wa ukaguzi.

Jinsi ya kuunganisha

Moja ya interface. 5 ya asili ya asili.

Kila jukwaa-kazi maisha katika kontakt. msingi wa OpsIQ anakaa generic, AI inakaa kutabirika, na ushirikiano wako unakaa ukaguzi.

Vichochezi

WaambieOpsIQtu kile kilichotokea.

Moto matukio ya wote kutoka jukwaa yako - au majina yako ya tukio la desturi. Kila mteja anajibu kwa wakati halisi, kwa utaratibu wa kipaumbele.

Matukio ya kumbukumbu

Matukio ya Universal + desturiinvoice.paid, ticket.created, subscription.cancelled, customer.signed_up Au hata wewe mwenyewe. Wafuasi wa Fan-outUbongo wa AI, sheria za automatisering, viunganisho vya kioo na mwisho wako wa wavuti wote huitikia. Amri ya kwanzaKusambaza kwa makusudi hivyo vioo vinaandika kabla ya tahadhari ya moto.

02mikataba ya kazi

WaambieOpsIQNi kitu gani ambacho mtu anaweza kufanya.

Mkataba wa utekelezaji ni mkataba waJSONAzimio: nini hatua inafanya, ambayo majukumu yanaweza kukimbia, vigezo gani inakubali, ikiwa uthibitisho unahitajika, na mwisho wa wito.

Programu ya

CCM haiwezi kufanya vitendo vyaUnaweza tu kuuliza kwa wale ambao wamejiandikisha. Sera ya kuthibitishaHatua za hatari husababisha kadi ya hakikisho kabla ya athari yoyote. Sehemu ya + GlottoKila hatua inatangaza majukumu na nyuso zinazoruhusiwa kuendesha.

Mkataba wa Utendaji -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
}

03WEB Ingia kwenye wavuti

Kusukuma matukio kwa stack yako - na ushahidi wa cryptographic.

Subscribe any URL kwa tukio lolote. OpsIQ POSTs the JSON payload iliyosainiwa na HMAC-SHA256 juu ya mwili mbichi - kuthibitisha katika mistari michache.

Ulinzi wa ReplayUfuatiliaji wa IDKurudi kwa Retres

Mtandao wa Webhook

Kuthibitisha 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);

04ya SDK

Weka mipaka ya lugha ambayo unatumia.

SDKs tatu rasmi kushughulikia uthibitishaji, kutia saini, retries, funguo za idempotency na majibu ya aina. Au kukaa mfumo-bure - kila SDK ni wrapper nyembamba karibu uso huo wa REST.

Mifano ya Wateja

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 ya Python3.10+· OpenAPI3.0.3

05Mfumo wa kontakt

Kuruka mara moja, kwenda juu ya kitu chochote.

Munganisho ni folda na darasa moja la PHP. OpsIQ inagundua, Usajili wa waya matukio, na msimbo wako maalum wa jukwaa unakaa safi kutoka msingi.

Mwongozo wa Kuunganisha

5 ya nguruweidentityProviders(), contextProviders(), registerActions(), subscribers(), handleWebhook(). Maandamano ya upinzaniactions.json Na kwa kuwa settings.json Kuthibitisha mikataba na uhakiki. Auto-KutambuliwaWeka nyaraka zako zote, zihifadhiwe kwenye akaunti yako.

Kwa nia ya kuchukua hatua za usalama

Kiingereza safi. Uchunguzi wa operesheni umefunguliwa.

OpsIQHaivumiliki wito sahihi. Inatembea kupitia mikataba iliyosajiliwa, huandaa mzigo wa malipo, huuliza uthibitisho wakati hatua inahitaji, na hutoa safu kamili ya ukaguzi wakati inatekeleza, hivyo AI ambayo inaweza kufanya kazi. Hatua ya Kamwe usiwe mtu ambaye huwezi kuamini.

Mkataba wa Muungano. A-Agreeing ni hatua tu ambazo umepiga.

Kuthibitisha kabla ya athari za upande. Hatua za hatari zinafungua kadi ya preview kwanza.

Kumbukumbu ya jumla. Kila hatua, majibu na matokeo ya haraka yalichukuliwa katika historia ya AI.

Angalia Mipangilio ya Hatua

4Hatua za hatuaLengo la ukaguzi

HMAC yaKabla ya utekelezaji

Hakuna simu zilizo tengenezwaUsajili wa mkataba tu

Uthibitisho wa kuthibitishwaPre-Presidency kabla ya matokeo

100%Ukaguzi waMajibu ya haraka + majibu

Marejeo ya kumbukumbu

APIJuu ya uso kwa mtazamo.

Kila mwisho wa msingi, auth yake, idempotency na kiwango cha kila-key. mkataba kamili wa kusoma mashine huishi katika kumbukumbu ya OpenAPI 3.0.3.

OpenAPI3.0.3Kumbukumbu ya kumbukumbu

Mwisho wa MwishoAuthani waKuwa na uwezoKiwango cha ukomo

Andika baruaKuunganishwa kwa Side Effects

POST /v1/events/fireHMAC yaNdiyo1000ya ya min

POST /v1/actions/runHMAC yaNdiyo200ya ya min

POST /v1/webhooks/testHMAC yaNdiyo60ya ya min

SomaMaelezo ya jumla, tiketi na kontakt

GET /v1/customers/{id}HMAC yaNdiyo2000ya ya min

GET /v1/ticketsHMAC yaNdiyo2000ya ya min

GET /v1/connectorsHMAC yaNdiyo2000ya ya min

mipaka ya kiwango kwa kila muhimu na kurudi katika kila jibu kama X-OpsIQ-RateLimit-Remainingna badala yake ni kurudisha nyuma 429 Kwa kuwa A Retry-After Mkataba kamili wa kusoma mashine (kila mwisho, schema na makosa) huishi katika OpenAPI3.0.3Kumbukumbu ya kumbukumbu.

Kujenga uhusiano wa kontakt

Kuunganisha Link katika Hatua ya tano.

Munganisho ni folda iliyo na kibinafsi. OpsIQ inagundua, Usajili unaunganisha matukio, na msimbo wako maalum wa jukwaa haujawahi kuingia ndani ya msingi.

1Kusanya karatasi kwa kutumia connector.php Kupanua AbstractConnector.

2Taarifa ya actions.json Na kwa kuwa settings.json wazi.

3Tumia utambulisho, mazingira na watoa huduma wa wavuti.

4Shiriki katika matukio unayoyajali.

5Weka alama, ruhusu kuingia kwenye akaunti.

Jaribu kabla ya meli

Sanduku la sandbox na tester ya mtandao wahook.

Kila nafasi ya kazi inafunua sanduku la mchanga: ufunguo tofauti uliotengwa ambao unapiga sawaAPIUkusanyaji wa data bila kuathiri data ya uzalishaji. POST /v1/webhooks/test Ili moto utoaji wa sampuli uliosainiwa kwenye kituo chako cha mwisho na kuthibitisha uthibitisho wako wa saini kabla ya kwenda kuishi. Mashinikizo ya kibinafsi yanaendesha njia ya msimbo sawa, bila drift ya tabia kati ya wingu na juu ya-prem.

Sandbox ya funguo Mtandao wa Webhook Tester Kazi za Cron Cloud & Self-hosted parity ya juu

Mwongozo wa Kuunganisha Mtandao wa Webhook

php · php

Darasa la darasa Kuwa na Acne Kuenea kwa AbstractConnector { Kazi ya umma Kwa upande wa (): Ukali wa kamba { Kurudi kwa kurudi ‘Aina ya; } - Kumuuliza nani ni mwigizaji Kazi ya umma Watangazaji wa utambulisho (): safu { Kurudi kwa kurudi [mpya AcmeIdentityProvider()]; } « Kufufua data ya kuishi katika AI haraka Kazi ya umma Watazamaji wa mazingira (): safu { Kurudi kwa kurudi [mpya AcmeContextProvider()]; } “Kwa kufanya hivyoOpsIQMatukio ya matukio Kazi ya umma Watumiaji (): safu { Kurudi kwa kurudi [“Malipo ya Fedha” => [mpya BillingMirror()]]; } Kupata Inbound Webhooks kutoka Acme Kazi ya umma handleWebhook (safu $body): tupu { /* … */ } }

Jinsi ya kulinganisha

OpsIQ dhidi ya a Ushirikiano wa DIY.

Nini mkataba-kufungwa, saini, jukwaa ukaguzi inakupa kwamba rolling webhooks yako mwenyewe na AI-hatua mabomba kamwe.

Uwezo wa uwezo	Kujiandikisha yako mwenyewe	TK-2147
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)	ya	✓
Connector pattern: platform code stays isolated	—	✓

Maswali Yanayoulizwa Mara kwa Mara

Maswali ya nyongeza, Alijibu.

Auth, saini, SDKs, sandboxing na mfano wa kontakt: kila kitu utakachouliza kabla ya ombi la kwanza.

API wito kuthibitisha na moja scoped Bearer muhimu: kutuma Authorization: Bearer opq_…. OpsIQAngalia upeo wa ufunguo na jukumu la mwigizaji kabla ya chochote kinachoendesha. Webhooks ni tofauti: kila webhookOpsIQKusafirisha mizigo kwa X-OpsIQ-Signature (Akhera ya 256 ya mwili wa nyama na X-OpsIQ-Timestamp Kwa ulinzi wa replay, ili uweze kuthibitisha sisi kwa kurudi, na webhooks inbound wewe kutuma ni kuthibitishwa njia hiyo.

AI inaweza tu kupendekeza vitendo ambavyo vipo katika Usajili wa mkataba wako wa utekelezaji. Haiwezi kuunda simu. Kila mkataba unatangaza nyuso, majukumu na vigezo vinavyoruhusiwa, na hatua yoyote inayoonyesha requires_confirmation Inafungua kadi ya hakikisho kwa mwanadamu kabla ya athari ya upande.

Kuwajibika hash_hmac('sha256', $rawBody, $secret) (Umri wa juu na usio na kipimo) X-OpsIQ-Signature Kuongoza kwa kuangalia mara kwa mara (hash_equalsKila utoaji pia hubeba timestamp, ufunguo wa idempotency na kitambulisho cha utoaji unaweza kufuatilia. snippet ya PHP kwenye ukurasa huu ni uhakiki wote.

Utoaji ambao haurudi kwa 200 umebadilishwa na kurudi nyuma ya maonyesho, kila mmoja akibeba ufunguo sawa wa malipo hivyo utoaji uliorudiwa haujawahi mara mbili. Unaweza kufuatilia kila jaribio kwa kitambulisho cha utoaji katika admin au kumbukumbu zako.

SDK za bure kwa PHP8.4ya ya node.js18Juu ya Python3.10+ kushughulikia kusaini, retries, funguo za idempotency na majibu ya aina. Wao ni wrappers nyembamba karibu na uso wa REST, hivyo unaweza pia kuzalisha mteja wako mwenyewe kutoka OpenAPI iliyochapishwa3.0.3Mkataba au wito waAPImoja kwa moja.

Ndiyo, kila nafasi ya kazi inafunua sanduku la mchanga na ufunguo wake ulio na upeo ambao hupiga sawa.APIbila ya kuathiri takwimu za uzalishaji, pamoja na POST /v1/webhooks/test Kuchoma sampuli saini utoaji katika mwisho wako na kuthibitisha uthibitisho wako kabla ya kwenda kuishi.

Ndiyo. Self-hosted inaweka kukimbia njia sawa code (saini moja, kiunganishi cha usajili huo, mkataba OpenAPI hiyo) hivyo hakuna drift tabia kati ya wingu na juu ya prem.

kontakt ni folda ya kibinafsi iliyo na folda moja ya PHP inayopanua AbstractConnectorAidha, pamoja na actions.json Na kwa kuwa settings.json Kwa hiyo, ni wazi kwamba wewe identityProviders(), contextProviders(), registerActions(), subscribers() Na kwa kuwa handleWebhook(). OpsIQ auto-kugundua, waya matukio na kuweka jukwaa- maalum code yako safi kutengwa kutoka msingi.