API poiblí & eochracha API

1. Forléargas

Faigh sonraí ó do spás chuig deaiseanna, stóras nó uirlisí inmheánacha. Seachas ID custaiméara a cheangal (identify, scóip scríofa de dhíth, féach Scóip eochracha), tá sé inléite amháin: ní féidir sonraí a athrú ná a scriosadh tríd an API.

• Bun-URL: https://www.mouseplayer.com/api/v1/
• JSON gach freagra.
• Fíordheimhnítear gach iarratas le heochair API agus teorannaítear dá spás — ní fheiceann eochair spáis sonraí spáis eile, fiú de thimpiste.
• Tá an taifeadadh iomlán (luch, léargais DOM) gan nochtadh tríd an API. Meiteashonraí, amhairc, imeachtaí agus deighleoga — go leor do thuairiscí gan ualach amh athsheinm a sheoladh timpeall.

2. Fíordheimhniú

Cruthaigh agus bainistigh eochracha faoi Eochracha API sa roghchlár cuntais (/api-keys). Úinéirí agus riarthóirí amháin a chruthaíonn nó a chúlghairmíonn.

Seol mar chomhartha Bearer sa cheanntásc Authorization de gach iarratas:

Le heochair ar iarraidh, míchumtha nó cúlghairthe, faightear 401 mar fhreagra:

Riachtanas plean

Tá REST API sna pleananna Business agus Enterprise . Tagann an plean ó úinéir an spáis, agus oidhreacht ag baill. Seiceáil ar gach iarratas, ní cruthú eochrach amháin — ar ísliú plean stopann sean-eochracha agus tugann 403.

Scóip eochracha

Tá scóip i réimír na heochrach, le fios a feidhme ag breathnú — i .env, ticéad nó teirminéal.

3. Teorainneacha ráta

Teorannaítear gach eochair go 60 iarratas sa nóiméadar fhuinneog rollach. Thar sin faigheann iarratais 429 go dtí glanadh na fuinneoige:

4. Críochphointí

GET/api/v1/projects

Liosta gach tionscadal (réadmhaoin rianaithe) sa spás.

GET/api/v1/projects/{channelid}/sessions

Seisiúin chuairteoirí tionscadail, is nua ar dtús. Leathanaithe.

GET/api/v1/sessions/{session_id}

Meiteashonraí seisiúin agus a amhairc. Eisiatar an t-ualach iomlán d'aon ghnó — úsáid Seinnteoir na deaise dó.

GET/api/v1/sessions/{session_id}/events

Imeachtaí saincheaptha seisiúin (na cinn a sheolann tú le mp('event', ...)), lena bparaiméadair.

GET/api/v1/projects/{channelid}/segments

Liosta deighleog tionscadail, cinn áitiúla agus cinn ar fud an spáis.

5. ID custaiméara ón gcúl

Ní bhíonn a fhios ag an mbrabhsálaí cé atá ann. Socraítear aitheantas B2B tar éis logála — sa chúl. Sa siopa le deimhniú ordaithe. Seo críochphointe an nóiméid sin.

POST /api/v1/sessions/{session_id}/identify
Authorization: Bearer mp_live_xxxxxxxxxxxx
Content-Type: application/json

{"user_id": "customer-4711"}

// 200 OK
{"data": {"session_id": "s_a1b2c3", "user_id": "customer-4711",
          "changed": true, "previous": null, "webhook_queued": true}}

Feictear ID sa liosta agus is inchuardaithe é; gníomhaíonn Webhook session_identified — sin mar a shroicheann CRM é.

6. Webhooks: fíorú sínithe

Cumraigh in aghaidh tionscadail faoi Comhtháthuithe, leis an rún sínithe ansin. Na ceanntásca seo ar gach seachadadh:

HMAC-SHA256 an síniú thar timestamp + "." + raw body, le rún sínithe do thionscadail mar eochair.

// PHP
$erwartet = 'sha256=' . hash_hmac('sha256', $timestamp . '.' . $rawBody, $secret);
if (!hash_equals($erwartet, $signature)) { http_response_code(401); exit; }

// Node
const expected = 'sha256=' + crypto.createHmac('sha256', secret)
                                     .update(timestamp + '.' + rawBody).digest('hex');

Seachadadh agus athiarrachtaí

Athiarracht tar éis 1 nóim, 5 nóim, 15 nóim, 1 u agus 6 u, ansin éirítear as. Freagraí 4xx seachas 408 agus 429 : ní dhéantar athiarracht orthu — deir siad "ní mar seo", ní "ní anois". Freagair 2xx go tapa agus oibrigh ina dhiaidh; teorainn ama 10 soicind.

Imeachtaí ar fáil

7. Earráidí & cóid stádais

8. Nótaí slándála

• Ní athraíonn eochracha mp_ro_ rud. Ní cheanglaíonn mp_rw_ ach IDanna; ní scriosann eochair ar bith sonraí ná ní easpórtálann amh-athsheinm.
• Scóip gach iarratais don spás féin — ní féidir ID eile a thabhairt le sonraí duine eile a fheiceáil.
• Cúlghair am ar bith ó /api-keys; i bhfeidhm láithreach.
• Cosain mar phasfhocal í. Má dhéanann tú commit poiblí de thimpiste, cúlghair láithreach agus cruthaigh ceann nua.