Programu ya Wasanidi programu · General API · webhooks · viunganisho

Fanya jukwaa yako ya utendaji.

Call 2,418 named operations through one contract-generated API, with least-privilege scopes, workspace pinning, dry-run validation and replay-safe writes. Subscribe to canonical events through HMAC-signed background webhooks, or build a governed package in the six-stage Connector Builder.

Kufunika funguo za Bearer2,418 contract actionsOpenAPI 3.0.3 + Ujumbe wa PostmanHuduma ya Mtandao wa HMAC
Maombi ya pekee katika
Webhook iliyosainiwa nje → 200 OK
Maisha ya kuishi Hatua ya Bear→ OpsIQ →Kujiandikisha kwa Webhook POST /api/v1.php Jamii:Wamiliki wa Bearer { "action": “Uchaguzi wa Ndani”, ^ Tnn., “kwa kweli.” · Kusubiri Sehemu ya Kazi +✓ Mkataba wa + ✓ Maombi ya kufuatilia Tovuti yako ya mwisho X-OpsIQ— Picha: Tiketi. replied Ukaguzi wa HMAC→Usimamizi wa Uendeshaji 200 OK
2,418Majina ya jumla API Matendo ya vitendo
69Mipaka ya chini ya upendeleo
dry_runKuthibitisha mikataba ya kuandika kabla ya utekelezaji
24hMafanikio ya Kuandika Replay
Maombi ya Lifecycle

Maombi ya kuingia. Tukio lililotangazwa.

Kuweka hatua kwa /api/v1.php Kwa ufunguo wa Bearer ulio na upeo. OpsIQ inapiga nafasi ya kazi, inathibitisha mkataba wa utekelezaji na ruhusa, kisha hutekeleza au kukimbia kavu. Matukio ya kujiandikisha kuondoka kupitia foleni ya utoaji iliyosainiwa ya HMAC na majaribio yanayofuatiliwa na kufungwa.

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.
Kucheza salama kuandika - Mafanikio idempotent anaandika kurudi majibu sawa kwa 24 Muda wa ziada; nakala za mara kwa mara zinashiriki madai moja.
App yako POST /api/v1.php Jamii:Wamiliki wa Bearer idempotency_key: idem_31c7 VERIFY - RUN - AUDIT Mwisho wa pointi yako POST /webhooks Ukaguzi wa HMAC 200 OK Kazi ya msingi + nafasi ya kazi + Idadi ya nafasi zilizokaguliwa Mkataba uliokubaliwa Kusafisha au kusafisha WEB | Maisha ya Haki { X-OpsIQ-Eventtiketi ya kurudi. replied X-OpsIQ-Delivery:Dlv_8f2a9 X-OpsIQ-Timestamp: 1786584362 X-OpsIQ-Signature: 4c4e0a7b ... } Waliopewa zawadi
01 Maombi ya lazima 02 Mahali pa kazi ya Pinspace 03 Mkataba wa kuthibitisha 04 Kusafisha au kusafisha 05 Mkutano wa dharura
Haraka ya kuanza

kutoka katika msingi wa Muungano unaoongozwa na Hatua tatu.

Kutoa ufunguo wa upendeleo mdogo, kugundua mkataba uliozalishwa, kavu-run kuandika, kisha ujiandikishe webhook wakati programu yako inahitaji utoaji wa tukio la background.

Mkataba wa ContributorKuunganisha
Kwa mujibu wa API · Mkataba wa Muungano unaoongozwa na 1 · Kuweka msingi wa Opq_live_xxx · Moja ya funguo za Bearer 2 · Kuratibu mikataba ya Barua ya posta /api/v1.php • Malengo ya meta.actions 3 · Kuandika barua ya tickets.reply · dry_run: true 4 · Kujihusisha na matukio tiketi. replied · HMAC utoaji
KutoshaKukausha_Kukauka→Kwa mujibu wa Katiba, mkataba huo
01

Kupata ufunguo

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

02

Kuthibitisha & kuthibitisha

Soma meta.actions, meta.action Na kwa kuwa meta.scopesMatumizi ya dry_run Kuthibitisha kuandika kabla ya utekelezaji.

03

Bonyeza & Subscribe

Ongeza ufunguo wa idempotency kwa kuandika, kisha ujiandikishe mwisho wako kwenye matukio ya canonical mahitaji yako ya maombi.

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.

01
Vichochezi

Waambie OpsIQ tu kile kilichotokea.

Matukio ya kihisabati kutoka kwenye jukwaa lako, au kufafanua tukio la desturi linaloongozwa. Wasajili hupokea tukio kupitia kipaumbele kilichosajiliwa na sheria za utoaji.

Matukio ya kumbukumbu
invoice.paid Tukio la Canton Ubongo waMazingira ya kuishi Kanuni zaKipaumbele cha kwanza 20 Macho ya kiooAndika kwanza Mtandao wa YahooMkataba wa
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.
02 mikataba ya kazi

Waambie OpsIQ Ni kitu gani ambacho mtu anaweza kufanya.

Kila operesheni iliyotajwa hupokea mkataba uliozalishwa: upeo, kipengele, kusoma au kuandika aina, hatari, sera ya kuthibitisha, ombi na majibu schema, msaada wa kukimbia kavu, upungufu na makosa imara.

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 utekelezaji · JSON
{
  "action": "tickets.reply",
  "kind": "write",
  "scopes": ["tickets.write", "admin"],
  "feature": "ticket_system",
  "risk": "medium",
  "confirmation": "recommended",
  "idempotency": "supported",
  "dry_run": true,
  "request": { "type": "object" },
  "response": { "required": ["success"] }
}
03 WEB Ingia kwenye wavuti

Kusukuma matukio kwa stack yako - na ushahidi wa cryptographic.

Subscribe any URL to any of the 52 deliverable events. OpsIQ POSTs the JSON payload signed with HMAC-SHA256 over the scheme version, the timestamp, the delivery ID and the body together, not the body alone, so yesterday's delivery cannot be replayed at you today.

Ulinzi wa ReplayUfuatiliaji wa ID5-step back-off
Mtandao wa Webhook
Kuthibitisha Webhook - php
$raw = file_get_contents('php://input');
$sig = $_SERVER['HTTP_X_OPSIQ_SIGNATURE'] ?? '';   // "v2=<hex>"
$ts  = (int)($_SERVER['HTTP_X_OPSIQ_TIMESTAMP'] ?? 0);
$id  = (int)($_SERVER['HTTP_X_OPSIQ_DELIVERY'] ?? 0);

if (abs(time() - $ts) > 300) http_response_code(401);   // replay window
[$ver, $hex] = array_pad(explode('=', $sig, 2), 2, '');  // split the prefix

$signed   = $ver . '.' . $ts . '.' . $id . '.' . $raw;   // NOT the body alone
$expected = hash_hmac('sha256', $signed, $secret);
if (!hash_equals($expected, $hex)) http_response_code(401);

$event = json_decode($raw, true);   // $id is stable across retries
04 ya SDK

Tumia HTTP moja kwa moja au kuzalisha mteja unayependa.

Jumla ya jumlaAPI Imechapishwa kama OpenAPI 3.0.3 na Postman.php kumbukumbu ya watumaji pamoja na Node na Python ushirikiano wateja cover tukio saini na mtiririko webhook; stack yoyote inaweza wito sawa JSON hatua za moja kwa moja.

Mifano ya Wateja
const response = await fetch(`${base}/api/v1.php`, {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.OPSIQ_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    action: "tickets.reply",
    dry_run: true,
    idempotency_key: crypto.randomUUID(),
    body: "Thanks. We are checking this now."
  })
});
$payload = json_encode([
  'action' => 'tickets.reply',
  'dry_run' => true,
  'idempotency_key' => bin2hex(random_bytes(16)),
  'body' => 'Thanks - we are checking this now.',
]);

$ch = curl_init($base . '/api/v1.php');
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_POSTFIELDS => $payload,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('OPSIQ_KEY'),
    'Content-Type: application/json',
  ],
]);
response = requests.post(
    f"{base}/api/v1.php",
    headers={
        "Authorization": f"Bearer {os.environ['OPSIQ_KEY']}",
        "Content-Type": "application/json",
    },
    json={
        "action": "tickets.reply",
        "dry_run": True,
        "idempotency_key": str(uuid.uuid4()),
        "body": "Thanks - we are checking this now.",
    },
)
Direct JSON HTTPOpenAPI3.0.3Orodha ya PostmanMsaada wa Ushirikiano
05 Mfumo wa kontakt

Kuruka mara moja, kwenda juu ya kitu chochote.

Kiunganisho ni kifurushi kinachosimamiwa kilichozalishwa au kuingizwa kwa njia ya Utambulisho, Auth, Mtihani, Hatua, Triggers na Mapitio. Kifungu chake kinatangaza uwezo wa nyuso OpsIQ inaruhusiwa kufunua.

Kuajiri wajenzi wa hatua sita
Hatua sita za uongoziUtambulisho, Auth, Mtihani, Hatua, Triggers na Mapitio kuweka mfuko kizazi kuelezea. Mkataba unaoendeshwa8 profiles and 57 capability types declare the surfaces a package implements. Kuachiliwa huruUsalama, uthibitisho na ukaguzi wa usawa kukimbia kabla ya mfuko ni kutibiwa kama tayari.
Kwa nia ya kuchukua hatua za usalama

Kiingereza safi. Uchunguzi wa operesheni umefunguliwa.

OpsIQ Haivumiliki 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 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.
4 Hatua za hatuaMalengo ya→Ukaguzi wa ukaguzi
HMAC yaKabla ya utekelezaji
“Kurudisha ankara ya mwisho ya Adamu” Hatua ya hatua 1 • Azimio la makusudi →saas.refund_invoice | Saas. juu: admin · jukumu: mmiliki · Hatua 2 kuthibitisha Hatua ya hatua 3 · Kuthibitisha na kuthibitisha · Barua ya maombi ya maombi ya · Ankara #8421 Uthibitisho wa kuthibitisha Hatua ya hatua 4 · Uwasilishaji wa maoni Matokeo ya haraka · matokeo 412ms Nabtech Digitalnet Limited
Hakuna simu zilizo tengenezwaUsajili wa mkataba tu
Uthibitisho wa kuthibitishwaPre-Presidency kabla ya matokeo
Maombi ya Ufuatiliaji+ Mkataba wa Matokeo
Marejeo ya kumbukumbu

API Juu ya uso kwa mtazamo.

One JSON POST surface exposes 2,418 named actions. Each generated contract declares auth scopes, read/write kind, risk, confirmation, request schema, dry-run, idempotency and stable errors.

OpenAPI 3.0.3 Kumbukumbu ya kumbukumbu
Hatua ya hatuaAuthani waAndika kuhusu usalamaKiwango cha chini
Andika matendoBarua ya posta /api/v1.php • Mkataba uliokubaliwa
ACTION tickets.replytickets.writeUCHAMBUZI WA KITABU; IdempotencyKuunganishwa / saa
ACTION security.reportsecurity.writeUCHAMBUZI WA KITABU; IdempotencyKuunganishwa / saa
ACTION platform.routes.writeUsimamizi wa adminUthibitisho wa + KeyKuunganishwa / saa
Kusoma na kugundua vitendoUunganisho wa moja kwa moja · Vifungu vya Kudumu
ACTION meta.actionsUtambuzi wa UmmaSoma tuKuunganishwa / saa
ACTION tickets.listtickets.readSoma tuKuunganishwa / saa
ACTION connectors.listconnectors.readSoma tuKuunganishwa / saa
Shughuli za HRKuundwa hr.* mikataba ya · hr.read / hr.write Maeneo ya
ACTION hr.people.listhr.readSoma tuKuunganishwa / saa
ACTION hr.people.createhr.writeUCHAMBUZI WA KITABU; IdempotencyKuunganishwa / saa
ACTION hr.org.treehr.readSoma tuKuunganishwa / saa
HR ya Watu haitoi matukio ya wavuti wa HR. Ifikia kupitia uso huo wa POST, au kujiunga na matukio mengine ya modules nyingine zinazochapisha. Watu waAPIKwa upande wake, Connector Na kwa kuwa Sehemu ya PeopleOS ya kumbukumbu ya developer· Mfumo wa uendeshaji ni muhimu, hivyo bila ya hr Unastahili kukataa, sio orodha tupu. Nini watu wa HR.

Mipaka ya kiwango imewekwa kwa ufunguo kwenye dirisha la saa. Majibu X-RateLimit-Limit, X-RateLimit-Remaining Na kwa kuwa X-RateLimit-ResetMaombi ya Kurudi 429 Pamoja na kuwa pamoja Retry-AfterTumia matumizi ya OpenAPI 3.0.3 Mkataba wa mkataba au Orodha ya Postman Kuundwa kutoka kwa registries sawa.

Kujenga uhusiano wa kontakt

Kujenga, Kuthibitisha na Kufunguliwa katika Hatua ya sita.

Anza kutoka kwa wasifu wa utawala au kufafanua mkataba mwenyewe. Mjenzi huthibitisha kila hatua kabla ya kuzalisha kifurushi cha kuunganishwa binafsi.

1utambulisho. Jina, slug, profile na uwezo alitangaza nyuso.
2Auth. API ya msingi, ya kisasa, ya msingi. OAuth 2.0 HMAC au mteja wa kawaida.
3ya majaribio. Angalia mipangilio ya uunganisho iliyofungwa kabla ya ufungaji.
4vitendo. Ramani inayoitwa operesheni, vigezo, mawanda na hatari.
5ya wawekezaji. Kutangaza matukio inbound, webhooks, uchaguzi na tabia sync.
6uchunguzi. Kusubiri mkataba uliozalishwa na kupitisha mlango wa kutolewa.
Jaribu kabla ya meli

Weka salama, kisha fuata maelekezo.

Matumizi ya matumizi dry_run juu ya vitendo vya kuandika mkono, kukimbia mtihani wa uunganisho wa kuunganishwa kwa Mjenzi, na kukagua wazi na mkataba uliozalishwa kabla ya kutolewa. Uhakiki wa Package unakagua majina ya uwezo, mipangilio, uthibitisho na faili zinazohitajika; wafanyakazi wa nyuma hushughulikia uchaguzi wa ufanisi na utoaji wa nje.

Ku-run Kuandika Uchunguzi wa uhusiano Mkataba wa kukubaliana Uwasilishaji wa Cron
php · php
Darasa la darasa AcmeConnector Kuenea kwa AbstractConnector { Kazi ya umma slug(): Ukali wa kamba { Kurudi kwa kurudi ‘Aina ya; } Kazi ya umma Jina la mtumiaji (): Ukali wa kamba { Kurudi kwa kurudi ‘Aa ya; } Kazi ya umma Maelezo ya mchezo(): Ukali wa kamba { Kurudi kwa kurudi ‘Kiwanda cha daraja’; } Tumia majina ya kiungo Kazi ya umma Uwezo wa uwezo (): safu { Kurudi kwa kurudi [“Majibu ya, Mtandao wa Yahoo]; } Kazi ya umma Kusanya kwa ajili ya (): safu { Kurudi kwa kurudi [[ya "key" => “Ndani ya, Aina ya "A" => “Utangulizi wa Neno”]]; } Kazi ya umma Uchunguzi wa maoni(safu $settings): safu { Kurudi kwa kurudi [Mafanikio ya ' => kweli]; } Kazi ya umma handleWebhook ( safu $payload, safu $headers, safu $settings ): safu { Kurudi kwa kurudi [Mafanikio ya ' => kweli]; } }
01 · Connector contract 2.4

Mfumo hauwezi kudai uwezo Kanuni yake haina.

OpsIQ\Connectors\ConnectorContract ni mamlaka.Ugunduzi wa Runtime, Mjenzi, vifurushi vya chama cha kwanza, kukubaliana, Mkuu API na kila kumbukumbu kusoma kwamba Usajili mmoja. kutangaza uwezo na faili tatu lazima kukubaliana na kila mmoja kabla ya OpsIQ Njia moja ya kwenda kwa ajili yenu.

ya FIG. 01connector package, parts manifest scale 1:1 · contract 2.4
  1. 01 connector.php Darasa la runtime
  2. 02 IdentityProvider.php Vifaa vya nje
  3. 03 SalesIngest.php Kukubaliana kwa ajili ya ()
  4. 04 actions.json Majina ya operesheni
  5. 05 settings.json Uendeshaji wa Configuration
  6. 06 connector_contract.json Mamlaka ya Kumiliki Mashine
07 signature.json Moja ya moja HMAC Kwa upande wake A-256 ya kila faili hapo juu, pamoja na ushahidi wa ed25519
Uwezo wa matrix all 57, as registered
Matendo ya vitendo Watangulizi wa Mtandao wa Yahoo journey_events muktadha wa guest_lookup Utambulisho wa utambulisho sales sales_reconciliation Billing ya payments Biashara ya biashara inbound_ticket outbound_reply ticket_merge sync_users sync_departments sync_orders sync_products sync_projects customer_import security_events security_native_block survey reply_feedback promo_audience promo_feed email_mailbox inbound_email outbound_email mailbox ai_tickets ai_reply ai_brain_aware native_api platform_bridge native_data ya crm block_registry inbound_comment outbound_note outbound_notification oauth reviews ya ndani ya seo site_intelligence Uchambuzi wa analytics comms admin_assets enterprise_hooks durable_queue ticket_mirror attachment_bridge database_migrations scheduled_workers conflict_resolution
Kuundwa kwa 30 Ufafanuzi wa 20 Uendelezaji wa upanuzi 7
Majibu ya maswali mawili, majibu mawili.

hmac-sha256 Juu ya malipo ya kuamua ya SHA-256 hes majibu Hii imebadilishwa tangu kuanzishwa kwa· Kuwa na ed25519 Majibu ya Je, ni lini ahadi hiyo ilitekelezwa na Nabtech, checkable na muhimu ya umma imefungwa na hakuna siri pamoja. Edit moja kwa moja na kuacha kwanza vinavyolingana.

marketplace.json Ni nje ya saini kwa ufafanuzi: mpangaji anaandika baada ya kusainiwa, hivyo mchapishaji hakuweza kamwe kuisaini.
02 · Fomu ya maombi/mutation_proof.php

Ni mchezaji ambaye hajawahi kushindwa Ni ya unpretended.

Vipimo vya kijani vinakuambia hakuna kilichovunjika leo. Hawakuambii walinzi ulioandika watazuia kitu kilichoandikwa kuacha, kwa sababu mlinzi ambaye hajawahi kutumia hupita kama mlinzi asiyefanya chochote. Kwa hivyo tunauzuia moyo wake kwa makusudi, na kudai kwamba ufuatiliaji wa sauti unapiga kelele.

· Kukataa kufanya kazi za kihalifu ya 1 verify_commerce_contracts
src/Connectors/CommerceRoleMapVerifier.php Mthwadi
211    /* A read role must never reach a destructive operation. */
212-   if ($isRead && $isDestructive) {
212+   if (false) {
213        $errors[] = "read role '{$role}' points at a destructive op";
214        return false;
215    }
Kwa kweli, Moja ya moja Mchezo wa maandishi unahitajika. mechi sifuri, au mbili, na ushahidi unaacha kabla ya uongo.
$ php tools/mutation_proof.php --spec=proofs.json
1[ ok ]hash    sha256 4f2a9c1e…
          remember the file exactly as it is
2[ ok ]control exit 0
          green BEFORE anything is touched
3[ ok ]mutate  1 match, lint ok
          one replacement, then php -l the mutant
4[RED ]prove   exit 1
          and "read role destructive" IS in the failures
5[ ok ]restore bytes written
          the original, not a regenerated copy
6[ ok ]verify  sha256 matches
          and the check is green again
 ══ PROVEN. file restored, hash matched, 1 proof run, 0 failed.
Ushahidi wa kushindwa ni Kamwe hakuwahi kamwe Ushahidi kwamba hundi akaenda vibaya si ushahidi kwamba walinzi kazi.

Mabadiliko hayajawahi kutumika.

Nakala ya utafutaji haikulingana, faili hiyo haikuguswa, suite ilipitishwa, na uthibitisho uliorekodiwa Green chini ya kanuni ya zamani Kuhusu msimbo ambao haujawahi kuwa wa zamani. Ulikamatwa kwa kuhitaji mechi moja ya maandishi na kulinganisha faili hashes ama upande.

Mabadiliko ya katiba yamezua jambo jingine.

Suite akaenda nyekundu kwa sababu faili kusimamishwa parsing au bootstrap kufa, na uthibitisho kumbukumbu nyekundu kwamba hakuwa na chochote cha kufanya na walinzi. hawakupata kwa linting mutant na wanaohitaji mutant. Jina la jina Kulinganisha kati ya kushindwa.

Haiwezi kuacha mabadiliko kwenye disk.

Kila mabadiliko yana nakala ya asili kwa gari la kando nje ya mti uliohifadhiwa, anaandika alama inayotaja mabadiliko bora, na inapotea na msimamizi wa kuzima kwenye kila njia ya kuondoka. Alama kutoka kukimbia iliyoanguka inaheshimiwa kabla ya mabadiliko mengine ya faili hiyo.

03 · Conformation ya

Kuthibitisha ni amri Kwa kutumia msimbo wa kuondoka.

Not a review queue where somebody reads your code and forms an opinion. Run the same suites we run, on your own machine, before you submit. 8 published JSON Schemas under doc/contracts/schemas/ Mipangilio ya kufunika, vitendo, specs za wajenzi, safari na ramani za tukio la biashara, maelekezo ya kazi, mikataba ya kontakt na maonyesho ya kutolewa.

  1. manifests Kukubaliana na kukubaliana
  2. Uwezo wa uwezo Kuna aina ya kozi katika darasa la runtime
  3. interfaces ambapo alitangazwa kuwa
  4. files Kila nyaraka zinazohitajika
  5. Matendo ya vitendo Kulinganisha vitendo vilivyo wazi
  6. destructive Uthibitisho wa kuthibitisha
  7. Utambulisho wa utambulisho Simu ya Mkono, sio Email
  8. Kurudisha Kurejea kwa mara ya pili, kamwe si kurudia
  9. Biashara ya Biashara Taarifa za nyongeza zinaendana na
  10. Docs ya Soma, badilisha, badilika
  11. Mipango ya Kila mmoja kila JSON Kuwa na uhakika
Kuondoka kwa exit 0 acme: conformant against contract 2.4 Tatizo la kushindwa jina hundi na faili. wewe kurekebisha ni, si sisi.
$ php tools/test_connector_conformance_all.php --connector=acme $ php tools/test_connector_json_schemas.php $ php tools/verify_commerce_contracts.php $ php tools/release_gate_connectors.php --require-signatures

Kuthibitisha kwanza katika akaunti ya kweli isiyo ya uzalishaji --live-settings=/secure/test-acme.jsonWakati wewe ni bado unapumzika, kubadilishana moja ya mwisho kwa ajili ya --unsigned-ok: Anachukua saini iliyokosekana kama onyo linalotarajiwa badala ya kujifanya ni nzuri.

04 · Biashara ya kuuza.json

Kufafanua nini unaweza kununua Ni faili, si usajili.

Kampuni ambayo inaweza kuuza matangazo ambayo yake mwenyewe Majibu ya operesheni OpsIQUwepo wa faili ni madai. Inaonekana katika mazingira ya kuuza wakati inatangaza na kutoweka wakati unaacha. Hakuna orodha ya kujiunga na hakuna mtu kuuliza.

Majukumu ya Canton commerce_roles.json Operesheni yako
catalog_search READ acme_search_products sawa order_get READ acme_get_order sawa order_create WRITE acme_create_order recovery: acme_get_order order_create WRITE db_insert_record Historia ya kawaida, hakuna ahueni
Kukataa

Kanani ya Kimaandiko Kuandika kuandika Jukumu lililowekwa kwenye rekodi ya kawaida. Mechi ni ya miundo: jina la kuhifadhi kando na kitenzi cha kubadilisha, chochote mkataba wako wa kutaja. Kuandika safu ya biashara moja kwa moja huruka bei ya jukwaa, upatikanaji wa kufuli na barua ya uthibitisho, na hutoa utaratibu mfumo wa mfanyabiashara mwenyewe nusu tu anaamini. recovery Aidha, wakati wa kupanda ni vigumu.

commerce_roles.jsonya
{
  "commerce": {
    "roles": {
      "catalog_search": { "operation": "acme_search_products", "transport": "http" },
      "order_get":      { "operation": "acme_get_order",       "transport": "http" },
      "order_create":   { "operation": "acme_create_order",    "transport": "http",
                         "recovery":  "acme_get_order" }
    }
  }
}
Makala yake mwenyewe kwa lengo: connector_contract.json ya kuanzishwa na mipango yake. additionalProperties:false, hivyo kuzuia mkono-kuandika kunaweza kushindwa kuthibitisha na kisha kuwa overwritten juu ya jenereta ijayo kukimbia.
01
Kufungwa kwa msamiati

Jukumu ambalo si la CommerceRole Hakuna kuwepo. OpsIQ Kamwe usiruhusu jina la operesheni, kwa sababu jina sio ahadi.

02
Hatua yako mwenyewe

Kazi lazima iwe katika mikono yako actions.jsonKufafanua moja ambayo haipo ahadi mteja kitu ambacho kisha hutoa hakuna.

03
Taarifa ya Kurejesha

Wakati hatari zaidi ni moja baada ya jukwaa inaweza tayari kuwa alifanya kazi. Bila idempotent "aliandika ardhi yangu" kuangalia, chaguo pekee ni retry kipofu au kupoteza utaratibu.

04
Malipo ya kuthibitisha

Aidha, wajibu wa kila mwenye dhamana ya malipo payment_profile Pamoja na hayo Mazingira ya mazingira, webhook_verify kutumia mfumo wa vyama vya wafanyakazi, na event_mapMazingira yasiyo na hali ni jinsi mtoa huduma wa wastani wa mtihani huchukua malipo ya moja kwa moja.

Mjenzi anathibitisha haya kama wewe aina na verifier inathibitisha mfuko uliosafirishwa. Wote huita kazi sawa, kwa hivyo hawawezi kutokubaliana.
⚖️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 uwezoKujiandikisha yako mwenyeweOpsIQ
Aina ya Bearer API + HMAC-signed webhooks Kujiandikisha kwa mkono
Uchoraji wa maandishi + 24 Kujiandaa kwa ajili ya mchezo ya ya
1 m→5 m→30 m2 wa→ 2h → 12hKurejea kwa Kulisha meza
Usajili wa mkataba (AI haiwezi kuunda simu)
Sera ya kuthibitisha kabla ya athari za upande
Hitilafu ya Kuingiliana + Kuomba ID Mwongozo wa magogo
HTTP + Chaguzi za Wateja Andika barua yako mwenyewe
OpenAPI 3.0.3 mkataba wa kusoma mashine Labda labda inaweza kuwa
Hatua ya 6 Mjenzi + mfuko wa kufungua lango Kujenga chombo cha
Kazi za msingi na mipaka ya saa Inatofautiana
Mfumo wa Kuunganisha: Msimbo wa jukwaa unakaa pekee
Maswali Yanayoulizwa Mara kwa Mara

Maswali ya nyongeza, Alijibu.

Uthibitishaji, mikataba, retries, kizazi cha mteja, upimaji salama na mfano wa kontakt, kabla ya ombi la kwanza la uzalishaji.

Jenerali Mkuu API Ujumbe wa simu Authorization: Bearer opq_…Keys inaweza kuwa bila wasiwasi, vikwazo au kusoma-tu, kubeba mawanda ya chini ya upendeleo, kutii kikomo cha saa na inaweza pinned kwa nafasi ya kazi. X-OpsIQ-Signature, X-OpsIQ-Timestamp, X-OpsIQ-Event Na kwa kuwa X-OpsIQ-Delivery.
AI inaweza kupendekeza tu shughuli zilizotajwa katika Usajili wa hatua. Kila mkataba uliozalishwa unatangaza wigo, kuomba maeneo, sera ya hatari na uthibitisho; shughuli ambazo sera zake zinahitaji kuthibitisha juu ya uhakiki wa kibinadamu kabla ya utekelezaji.
Kuwajibika hash_hmac('sha256', $rawBody, $secret) na kuilinganisha na ile ya dhahabu. X-OpsIQ-Signature Matumizi ya kutumia hash_equals· Tarehe ya kuzaliwa X-OpsIQ-Timestamp Ndani ya dirisha la kucheza na kutumia X-OpsIQ-Delivery kama kitambulisho cha utambulisho wa ufuatiliaji.
Jaribio lisilofanikiwa linaingia foleni ya utoaji wa background. OpsIQ Maoni kwenye The1Dakika moja, 5Dakika moja, 30 Dakika moja,2kwa saa na 12- saa ladder wakati wa kuhifadhi kitambulisho cha utoaji na kujaribu historia ya uchunguzi.
Wito kwa JSON uso hatua moja kwa moja, kuagiza ukusanyaji yanayotokana Postman, au kuzalisha mteja kutoka OpenAPI 3.0.3.Watumiaji wa kumbukumbu ya PHP na Wateja wa Ushirikiano wa Node / Python kusaidia tukio na mtiririko wa wavuti; wao ni wasaidizi badala ya tofautiAPI mikataba.
Matumizi ya matumizi dry_run juu ya vitendo ambao mkataba yanayotokana mkono yake, kukimbia Connector Builder imefungwa uunganisho mtihani, kukagua mafaili yake yanayotokana, na kupita mfuko kukubaliana na kufungua milango kabla ya kutibu kontakt kama tayari.
Uhuru wa vyombo vya habari unachangia katika API na mikataba ya kontakt kutoka kwa registries yake mwenyewe ya muda wa kukimbia. kupelekwa kwako inamiliki umma wake URL, siri, kuhifadhi na cron / wafanyakazi, hivyo tabia inapaswa kuthibitishwa dhidi ya kutolewa imewekwa badala ya kudhani kutoka mazingira ya wingu.
« Munganisho ni mfuko unaoongozwa na adapter, settings.jsonKwa upande wa hiari actions.json, mkataba wa uwezo uliozalishwa, nyaraka na upanuzi wa biashara ya hiari. Wajenzi wa hatua sita wanakusanyika; Usajili unagundua; kukubaliana na kufungua milango kuthibitisha.