Platform-ka RAAD

Tixraaca API

Waa API gaar ah, oo token lagu xaqiijiyo, kaas oo hantidaada ku xiraya nidaamyadaada. Waxa uu akhriyaa xogta la mid ah tan console-ka RAAD akhriyo, marka aaladda markaas uun xog soo dirtay markiiba halkan waa laga helayaa. Raaci Authorization: Bearer <token> codsi kasta. Jawaab kasta waa { data }, waxaana u dheer { page } liisaska bogagga loo qaybiyay, qaladaadkuna waa { error: { code, message } }.

Base URL openapi.json Hel token

Heshiisku laftiisu waa gaar. openapi.json iyo console-ka la dhexgalo labaduba waxay u baahan yihiin session iskaashato ama platform, markaa ka fur tab aad horey ugu gashay portal-ka.

Xaqiijinta

Hal header, codsi kasta.

Tokens-ka waxaa laga bixiyaa Settings → API gudaha portal-ka. Token-ku wuxuu leeyahay hal macmiil wuxuuna wataa scopes go'an, sidaas darteed habka ugu badbaadsan waa hal token integration kasta oo leh kaliya scopes-ka uu integration-ku u baahan yahay. Token-ka hal mar uun baa la tusayaa markii la samaynayo. U xifdi sida sir oo kale oo beddel adigoo mid cusub samaynaya, kadibna burinaya kii hore.

Ku dir token-ka gudaha header-ka Authorization. Tokens-ka query-string lama aqbalayo, codsi aan header lahayn, token dhacay ama token la buriyay wuxuu soo celinayaa 401. U wac /health si aad u xaqiijiso macmiilka iyo scopes-ka uu token-ku matalayo inta aadan wax kale isku xirin.

Scopes

Hal scope oo akhris ah aag kasta. Token-ku wuxuu wataa kaliya kuwa integration-kiisu u baahan yahay.

Token-ka aan lahayn scope-ka uu endpoint u baahan yahay wuxuu helayaa 403, ma aha liis maran, sidaas darteed dhibaatada ogolaanshuhu marna uma ekaato xog maqan. Scopes waa la isku daraa waxaana la dejiyaa marka token-ka la bixinayo.

devices:read
Diiwaanka aaladaha. /devices iyo /devices/{id}.
tracking:read
Dhaqdhaqaaqa iyo telemetry. /positions, /positions/history, /sensors iyo /geofences.
alerts:read
Wixii uu platform-ku soo saaray iyo sababta. /events, /incidents iyo /rules.
assets:read
Waxyabaha aaladaha lagu xiray. /assets iyo /assets/{id}.
drivers:read
/drivers.
compliance:read
Macluumaadka dukumintiga iyo dhicitaanka. /documents.
maintenance:read
/maintenance.
fuel:read
Buugga tamarta, xirmooyinka, armaajooyinka iyo xarunta shidaalka. Wax walba oo hoos yimaada /power.
meter:read
Meters-ka casriga ah, akhrintooda iyo ku-shubashada. Wax walba oo hoos yimaada /meters.
sense:read
Sensors-ka deegaanka iyo akhrintooda. Wax walba oo hoos yimaada /sense.
cam:read
Xogta dheeriga ah (metadata) ee clip-ka iyo dhacdooyinka badbaadada darawalka. /cam/clips.
esg:read
Raadadka kaarboonka iyo diiwaanka ka dambeeya. Wax kasta oo ku hoos jira /carbon.
reports:read
/reports.
support:read
/support/cases.

/health uma baahna wax scope ah oo aan ahayn token sax ah, taas oo ka dhigaysa endpoint-ka ugu habboon ee lagu hubiyo in nidaamku shaqaynayo (uptime check) ama lagu tijaabiyo aqoonsiga (credential test).

Qaladaadka iyo xaddidaadda

Hal qaab oo cilladeed (error shape), wax kasta oo khaldamayba.

200Waa hagaag (OK). Body-gu waa { data }, iyo { page } marka liisasku yihiin paginated.
400Codsi xun (Bad request). Parameter ayaa maqan ama khaldan. Waxaa soo celiya /positions/history marka deviceId, from ama to ay maqan yihiin ama aan la akhriyi karin.
401Lama oggola (Unauthorized). Token maqan, khaldan, dhacay ama la laalay.
403Waa mamnuuc (Forbidden). Token-ku waa sax laakiin ma lahan scope-ka uu endpoint-kani u baahan yahay.
404Lama helin (Not found). Xogta lama hayo, ama uma muuqato token-kan. Labada xaaladood si ula kac ah looma kala sooci karo, si token-ka aan loogu isticmaalin in lagu baaro aaladaha (devices) ku jira tenant kale.

Xaddidaadda codsiyada (Rate limiting)

Codsiyada waa loo xaddiday token kasta. Akhri /positions intii aad mid mid u dul mari lahayd /devices/{id}, oo isticmaal cursor si aad u dhex marto /events intii aad mar kale akhrin lahayd madaxa liiska. Haddii aad u baahan tahay xaddid ka sarreeya si aad xog badan u dhoofiso (bulk export), na weydii ka hor intaadan dhisin.

Qaybinta bogagga

Waxay ku salaysan tahay Cursor, liis kasta oo si aan xad lahayn u kordha.

Liisaska qaabka diiwaanka ah (/devices, /positions, /rules, /meters iyo wixii la mid ah) waxay soo celiyaan wax kasta oo uu token-ku arki karo hal wicid (one call). Diiwaanada (logs and ledgers) waxay u koraan xad la'aan, sidaas darteed /events, /incidents, /documents, akhrinta Meter-ka, akhrinta Sense-ka, clip-yada, diiwaanka kaarboonka, warbixinada iyo kiisaska waa paginated. Mid kasta wuxuu soo celiyaa kuwa ugu cusub horta, illaa tirada limit-ka, iyadoo page.nextCursor la xusayo marka ay wax harsan yihiin. Qiimahaas ku celi adigoo ka dhigaya cursor si aad u sii wadato. Marka nextCursor yahay null waxaad gaartay dhammaadka. Endpoint-ka isticmaala pagination wuxuu ku sheegaa header-kiisa, wuxuuna qaataa isla labadaas parameter.

Kaydi id-ga ugu cusub ee aad shaqaysay intii aad kaydin lahayd timestamp. Dhacdooyinka (Events) waxaa loo qoraa sida loo qiimeeyo, aaladda (device) dib u xiranta markay go'do kadib waxay buuxin kartaa dhacdooyin leh qiimeyaal occurredAt oo ka duqsan kuwii aad horey u aragtay.

Endpoints-ka

Labaatan iyo sagaal endpoints, dhammaantood waa akhris-keliya (read-only) gudaha v1. Dooro mid si aad u aragto parameters-kiisa, codsi (request) ku qoran saddex luuqadood iyo jawaab (response) dhab ah.

Nidaamka

Xaqiiji in token-ku shaqeynayo oo eeg waxa uu gaari karo.

Waxay soo celisaa tenant-ka iyo scopes-ka uu token-kani metelo. Waxay aqbashaa token kasta oo sax ah, sidaas darteed waxay u shaqaysaa sidii hubinta caafimaadka (health check) nidaamka iyo wicitaanka ugu horreeya ee la sameeyo marka integration-ku bilaabo inuu soo celiyo 403.

token kasta oo sax ah

Codsi

Jawaab

Aaladaha

Diiwaanka: waxa nidaamka lagu soo kordhiyay, xaaladda uu ku jiro, iyo SIM-ka uu ku xiran yahay.

Aalad (device) kasta oo token-kani arki karo, oo leh xaaladdeeda hadda iyo waqtigii ugu dambeeyay ee ay xog soo dirtay. Waxay soo celisaa dhammaantood intii ay bog (page) soo celin lahayd, marka kaydi (cache) oo ku cusboonaysii jadwal intii aad codsi kasta (per request) ka dhigi lahayd.

devices:read

Codsi

Jawaab

Xusuusin

state waa mid ka mid ah moving, idle, stopped, offline ama nodata. nodata macnaheedu waa aaladda waa la diiwaangeliyay laakiin weligeed xog ma soo dirin; offline macnaheedu waa horey ayay xog u soo dirtay balse hadda way aamusan tahay. protocol wuxuu magacaabayaa decoder-ka gacanta ku haya aaladda, oo ah mid ka mid ah 267-ka la taageero.

Hal aalad (device) oo leh xaaladdeeda iyo xogteeda (telemetry) ugu dambeysay.

devices:read404 haddii aan la arki karin

Path parameters

idintegerWaa lagama maarmaan
deviceId-ga laga helo /devices. Ma aha uniqueId-ga ku daabacan qalabka.

Codsi

Jawaab

Goobaha

Halka ay wax kasta hadda joogaan, iyo halka ay hal aalad soo martay.

Goobta ugu dambeysa ee qalab kasta oo token-kani arki karo. Tani waa endpoint-ka laga soo waco khariiradda tooska ah: hal wicitaan ayaa soo celinaya dhammaan qalabka, markaa uma baahnid inaad qalab kasta gaar u wacdo.

tracking:read

Codsi

Jawaab

Xusuusin

lastFix waa goorta GPS-ka la qabtay; lastUpdate waa goorta uu platform-ka helay. Qalabka ku jira tuneelka ama kunteenarka wuxuu soo sheegaa lastUpdate cusub laakiin lastFix duug ah. U tixgeli farqiga u dhexeeya labadan mid lumiyay GPS-ka intii aad u qaadan lahayd in qalabku lumay. lat iyo lon waa null ilaa laga helayo fix-ka ugu horreeya.

Taariikhda dhaqdhaqaaqa hal qalab muddo cayiman, oo horay loogu sii qaybiyay safarro iyo istaagid iyadoo la soo koobay. Uma baahnid inaad dib uga dhisto safarrada xogta cayriin.

tracking:read400 haddii mudada khalad tahay404 haddii aan la arki karin

Halbeegyada query-ga

deviceIdintegerWaa qasab
Qalabka warbixintiisa la doonayo.
fromdate-timeWaa qasab
Bilowga mudada, ISO 8601. Ku dir UTC adoo raacinaya xarafka Z gadaal.
todate-timeWaa qasab
Dhammaadka mudada, ISO 8601. Ku soo koob mudada ilaa hal maalin wicitaan kasta oo loogu talagalay qalabka aad u shaqeeya.

Codsi

Jawaab

Sensors-ka

Dareemayaasha (sensors) la habeeyay iyo qiimayaashooda ugu dambeeyay, ee qalab kasta.

Dareeme (sensor) kasta oo la habeeyay oo ku xiran qalab kasta oo token-kani arki karo, iyadoo la socota akhrinta ugu dambeysa. Qiimayaasha horay ayaa loo jaangooyay, markaa baaritaanka shidaalku (fuel probe) wuxuu ku akhrinayaa litir beddelkii xog cayriin ah.

tracking:read

Codsi

Jawaab

Dhacdooyinka

Bilaabidda xeerarka iyo dhacdooyinka qalabka, kuwa ugu cusub ayaa soo horreeya.

Wax kasta oo uu platform-ku ka diiwaangeliyay qalabka: bilaabidda xeerarka iyo dhacdooyinka uu qalabku laftiisu soo sheegay. Kuwa ugu cusub ayaa soo horreeya, cursor-paginated. Tani waa xogta (feed) aad ku xiri karto nidaamka tigidhada (ticketing) ama bakhaarka (warehouse).

alerts:readcursor-paginated

Halbeegyada query-ga

limitintegerWaa doorasho
Rafka (rows) bog kasta. Sida caadiga ah waa 100, wuxuuna ku eg yahay 500.
cursorstringWaa doorasho
Waa page.nextCursor ee jawaabtii hore. Ka reeb marka aad eegayso bogga koowaad.

Codsi

Jawaab

Xusuusin

severity waa mid ka mid ah critical, warning, info ama muted. Dhacdooyinka muted waa lagu qariyaa console-ka laakiin halkan ayey ku soo baxayaan, markaa ku sifee (filter) haddii aad ka turjumayso liiska shaqada ee maamulaha beddelkii log-ga oo dhan. page.nextCursor waa null bogga ugu dambeeya.

Xayndaabyo

Aagagga macmiilka, oo leh qaab (geometry) aad sawiri karto.

Aag kasta oo macmiilku leeyahay, iyadoo qaabka (geometry) horay loo fahmay. Ku lamaani /positions si aad u muujiso isla khariiradda uu console-ku muujiyo.

tracking:read

Codsi

Jawaab

Xusuusin

Isku-duwayaasha (coordinates) waa [longitude, latitude], oo la jaanqaadaya GeoJSON. Taasi waxay lid ku tahay goobaha lat/lon ee position-ka, markaa hubi sida ay u kala horreeyaan ka hor intaadan sawirin. radius wuxuu ku qoran yahay mitir. Boligoonka (polygon) laguma xirin adiga; ku celi barta koowaad haddii barnaamijka sawirayaagu u baahan yahay.

Hantida

Waxyaabaha ay macaamiishaadu maamulaan, oo aan ahayn qalabka lagu xiray.

Hanti (asset) kasta oo token-kani arki karo, oo leh boorsada attributes ee gaarka u ah nooceeda. Qalab (device) waa qalabka hardware-ka; hantidu (asset) waa gaariga xamuulka (truck), taraaylaha (trailer), kunteenarka (container) ama goobta uu ka warbixinayo, waana liiskan waxa nidaamyadaadu ay ku tiirsan yihiin.

assets:readcursor-paginated

Halbeegyada query-ga

typestringWaa doorasho
Kaliya hantida (assets) hal nooc ah, tusaale ahaan truck, trailer, container, site ama fridge.
statusstringIkhtiyaari
active, maintenance ama retired.
limitintegerWaa doorasho
Rafka (rows) bog kasta. Sida caadiga ah waa 100, wuxuuna ku eg yahay 500.
cursorstringWaa doorasho
Waa page.nextCursor ee jawaabtii hore. Ka reeb marka aad eegayso bogga koowaad.

Codsi

Jawaab

Xusuusin

mobility waxaa laga soo qaataa nooca: mobile oo loogu talagalay gaadiidka, isjiidka iyo kunteenarada, iyo fixed oo loogu talagalay goobaha, dhismooyinka, qolalka, qaboojiyayaasha iyo armaajooyinka. Furayaasha ku dhex jira attributes waxay ku xiran yihiin nooca, sidaas darteed u akhri sida xirmo isku dhafan halkii aad ka eegi lahayd qaab go'an.

Hal hanti oo uu la socdo darawalka lagu meeleeyay iyo aaladaha ku xiran. Tani waa isku xirka u dhexeeya adduunka hantida iyo adduunka aaladaha: halkan ka bilow si aad u ogaatid deviceId-ga aad u gudbinaysid /positions/history.

assets:read404 haddii aan la arki karin

Path parameters

idstringQasab ah
Hantida id-geeda oo ka yimid /assets.

Codsi

Jawaab

Darawallada

Yaa wada gaariga, iyo mid kasta marxaladda diiwaangelintiisa (onboarding).

Darawalada macmiilka iyo faahfaahintooda xiriirka, lambarka laysinka iyo stage-ka diiwaangelinta. Marxaladda waxaa laga soo xisaabiyaa dukumiintiyada la hayo, sidaas darteed darawalka caymiskiisu dhaco wuxuu si toos ah uga baxayaa ready iyadoo aan qofna wax ka beddelin xogtiisa.

drivers:readcursor-paginated

Halbeegyada query-ga

stagestringIkhtiyaari
Mid ka mid ah draft, invited, in_review, ready, suspended ama archived.
limitintegerWaa doorasho
Rafka (rows) bog kasta. Sida caadiga ah waa 100, wuxuuna ku eg yahay 500.
cursorstringWaa doorasho
Waa page.nextCursor ee jawaabtii hore. Ka reeb marka aad eegayso bogga koowaad.

Codsi

Jawaab

Xusuusin

suspended iyo archived waxaa loo beddelaa gacanta mana isbeddelaan; marxaladaha kale oo dhan dib ayaa loo xisaabiyaa mar kasta oo dukumiinti isbeddelo ama waqtigiisu dhaco. status waxaa loo hayaa iswaafajin kaliya waxna ma maamusho hadda. Isticmaal stage.

U-hoggaansanaanta

Dukumiintiyada iyo taariikhaha ay dhacayaan, iyada oo aan la socon faylka (file bytes).

Xogta dukumiintiyada (metadata) ee macmiilka, waxaana lagu horreysiiyaa kuwa ugu hor dhacaya. Faylasha la diiday kuma jiraan. Xariiq kasta wuxuu kuu sheegayaa waxa dukumiintigu yahay, cida ama waxa uu leeyahay iyo goorta uu dhacayo; faylka laftiisa lagama helo API-ga.

compliance:readcursor-paginated

Halbeegyada query-ga

typestringWaa doorasho
Kaliya hal nooc oo dukumiinti ah, tusaale ahaan insurance, licence, photo ama nooc uu macmiilku dejiyay.
limitintegerWaa doorasho
Rafka (rows) bog kasta. Sida caadiga ah waa 100, wuxuuna ku eg yahay 500.
cursorstringWaa doorasho
Waa page.nextCursor ee jawaabtii hore. Ka reeb marka aad eegayso bogga koowaad.

Codsi

Jawaab

Xusuusin

Dukumiintigu wuxuu leeyahay hanti ama darawal, sidaas darteed mid ka mid ah assetId iyo driverId ayaa la dejiyaa. Si aad u samayso xogta kuwa dhacaya, ku baaro boggaga adigoo isticmaalaya limit=500 oo jooji marka expiryDate uu ka dambeeyo waqtiga aad doonayso; liiska horay ayaa sidaas loogu kala horreysiiyay.

Daryeelka

Hawlaha dayactirka (service), baaritaanka (inspection) iyo xalinta ciladaha ee hantida.

Hawlaha dayactirka, kuwa ugu horreeya ee la qabanayo ayaa lagu horreysiiyaa. Hawshu waxay ku xiran tahay taariikh, akhrinta masaafada (odometer), ama labadaba, sidaas darteed dayactir (service) loo ballansan yahay bisha soo socota ayaa dhici karta inuu soo hormaro haddii gaarigu shaqo badan qabto.

maintenance:readcursor-paginated

Halbeegyada query-ga

statusstringIkhtiyaari
scheduled, done ama cancelled.
limitintegerWaa doorasho
Rafka (rows) bog kasta. Sida caadiga ah waa 100, wuxuuna ku eg yahay 500.
cursorstringWaa doorasho
Waa page.nextCursor ee jawaabtii hore. Ka reeb marka aad eegayso bogga koowaad.

Codsi

Jawaab

Xusuusin

kind waa service, inspection, repair ama other. cost waa lacagta biilka ee macmiilka waxaana la geliyaa oo kaliya marka hawsha la qabto.

Shilalka iyo shuruucda

Ogeysiisyada oo la isugu geeyay dhacdooyin (incidents), iyo xeerarka kiciya.

Ogeysiisyada oo lagu soo ururiyay dhacdooyin. Senser-ka shidaalka oo qayliya afartan jeer habeenkii waa hal dhacdo oo wadata count: 40, ma aha afartan xariiq, sidaas darteed kan ayaa ah xogta loo adeegsado nidaamyada tigidhada ama heeganka (on-call). /events ayaa weli ah diiwaanka sidiisa ah (raw log) ee hoose.

alerts:readcursor-paginated

Halbeegyada query-ga

statestringIkhtiyaari
open, acknowledged, snoozed ama resolved.
modulestringIkhtiyaari
Module-ka kiciyay, tusaale ahaan tracking, fuel, meter ama sense.
limitintegerWaa doorasho
Rafka (rows) bog kasta. Sida caadiga ah waa 100, wuxuuna ku eg yahay 500.
cursorstringWaa doorasho
Waa page.nextCursor ee jawaabtii hore. Ka reeb marka aad eegayso bogga koowaad.

Codsi

Jawaab

Xusuusin

Dhaqdhaqaaqa ugu dambeeyay ayaa ugu horreeya, iyadoo loo kala horreysiiyay lastAt. Kaliya mid ka mid ah deviceId, assetId, meterId ama packId ayaa magacaabaya shayga la eegayo, taasoo ku xiran module-ka.

Xeer kasta oo digniin ah oo loo habeeyay macmiilka, dhammaan qaybaha: waxa uu kormeero, xadka (threshold), heerka khatarta ee uu kiciyo, qalabka ama kooxaha uu khuseeyo iyo haddii uu daaran yahay. Akhri tan si aad u sharaxdo dhacdo, ama aad u hubiso waxa uu macmiilku dhab ahaan kormeerayo.

alerts:read

Codsi

Jawaab

Xusuusin

Xeerka leh deviceIds iyo groupIds eber ah wuxuu khuseeyaa macmiilka oo dhan. Qaabka threshold wuxuu ku xiran yahay trigger.

Power

Shidaalka iyo korontada oo hal diiwaan ku wada jira, oo lagu daray baakadaha, sanaadiiqda iyo barxadda.

Diiwaanka mideysan ee tamarta, waxa ugu cusub baa horreeya. Buuxin, dalacsiin, isweydaarsi, iyo iibin kasta halkan ayay ku soo dhacaan sidii hal saf oo leh cadadka, halbeegga, iyo lacagta, ha ahaato naafto ama kilowatt-saac. Ku hubi kaarka shidaalka ama biilka dalacsiinta (charging).

fuel:readxad kaliya, ma leh cursor

Halbeegyada query-ga

limitintegerWaa doorasho
Safafka la soo celinayo. Sida caadiga ah waa 100, xadka ugu sarreeya waa 500.

Codsi

Jawaab

Xusuusin

kind waa swap, sale, charge ama fill. direction waa in tamarta la iibsaday iyo out tamarta la iibiyay ama la bixiyay, marka laysku daro amount iyadoo loo eegayo jiheynta waxay ku siinaysaa qarashka iyo dakhliga.

Baytari kasta oo goobta yaalla iyo heerkiisa dabka, xaaladdiisa caafimaad iyo halka uu ku sugan yahay: dibadda, armaajo, isagoo dalacmaya, la calaamadiyay, ama hawlgab noqday.

fuel:read

Codsi

Jawaab

Xusuusin

Kani wuxuu soo celinayaa diiwaanka buuxa ee baytariga, marka filo xogo dheeraad ah maadaama nidaamku korayo. Kuwa sare waa joogto. status waa in_field, in_cabinet, charging, flagged ama retired.

Armaajooyinka isweydaarsiga baytariyada oo muujinaya boosaska la isticmaalayo, iyo kaalinta (forecourt) haddii macmiilku wado mid: bambooyinka iyo dab-qeeybiyeyaasha iyo xadiga la isticmaalay maanta. Hal codsi (call) wuxuu shaashadda derbiga siinayaa wax kasta oo ay u baahan tahay.

fuel:read

Codsi

Jawaab

Xusuusin

forecourt waa null macmiilka aan lahayn goob wax bixin. Tirada armaajadu (ready, charging, fault) markii laysku daro waxay noqonayaan boosaska la isticmaalayo; inta ka hartay bays way maran yihiin.

Xadiga tamarta, qarashka, iyo dakhliga ee xilligii la soo dhaafay, oo ay la socdaan qiyaasaha kaarboonka ee qaybta ESG ay ka soo saarto. Waa tirooyinka uu ku furmo warbixinta billaha ah.

fuel:read

Halbeegyada query-ga

daysintegerIkhtiyaari ah
Dhererka wakhtiga la eegayo. Sida caadiga ah waa 30, xadka ugu sarreeyana waa 365.

Codsi

Jawaab

Xusuusin

scope2Kg waa qiiqa ka dhasha dalacsiinta; avoidedKg waa gubashada ay beddelaadahaas meesha ka saareen. Labaduba waa tilmaan, waxayna isticmaalaan qodobbo la mid ah kuwa /carbon/summary.

Meters

Mitirada casriga ah (smart meters), akhrintooda iyo lacag ku shubashada (prepaid).

Mitir kasta oo casri ah (smart meter) xaaladdiisa bixinta korontada, haraadiga lacagta, iyo markii ugu dambeysay ee uu soo diray xog. Meesha nidaamku ka soo qaadan karo xaalad cusub oo mitirka ah codsigan, live waa true.

meter:read

Codsi

Jawaab

Xusuusin

relayState waa connected, disconnected ama unknown. Mitirka leh haraadi eber ah oo relay-ga laga jaray wuxuu u go'ay lacag la'aan; in lacag lagu shubo ayaa dib u xiraysa. status waa enrolled, offline ama fault.

Akhrinta xiliyaysan ee hal mitir, xogtii ugu dambaysay baa horreysa. Saf kastaa waa hal diiwaan OBIS oo leh hal waqti, markaa mitirka soo sheega tamarta soo gasha iyo korontada degdega ah wuxuu soo saaraa laba saf xilli kasta.

meter:readcursor boggeeyay404 haddii aan la arki karin

Path parameters

idstringQasab ah
Nambarka (id) mitirka ee ka yimid /meters.

Halbeegyada query-ga

limitintegerWaa doorasho
Rafka (rows) bog kasta. Sida caadiga ah waa 100, wuxuuna ku eg yahay 500.
cursorstringWaa doorasho
Waa page.nextCursor ee jawaabtii hore. Ka reeb marka aad eegayso bogga koowaad.

Codsi

Jawaab

Xusuusin

1-0:1.8.0 waa wadarta tamarta la soo dejiyay ee kWh; 1-0:1.7.0 waa awoodda la soo dejiyay ee xilligan lagu jiro ee kW. Isticmaalka muddada waa faraqa u dhexeeya laba akhris oo 1.8.0 ah.

Taariikhda shubista hormarinta ah ee hal mitir, kuwa ugu cusub ayaa ugu horreeya: imisa la iibsaday, dariiqee, in token-ku gaaray mitirka, iyo UTRN-ka halkii laga soo saaray.

meter:readcursor boggeeyay404 haddii aan la arki karin

Path parameters

idstringQasab ah
Nambarka (id) mitirka ee ka yimid /meters.

Halbeegyada query-ga

limitintegerWaa doorasho
Rafka (rows) bog kasta. Sida caadiga ah waa 100, wuxuuna ku eg yahay 500.
cursorstringWaa doorasho
Waa page.nextCursor ee jawaabtii hore. Ka reeb marka aad eegayso bogga koowaad.

Codsi

Jawaab

Xusuusin

status waa pending, delivered ama failed. operator ayaa magacaabaya isticmaalaha nidaamka ee shubista gacanta ah wuxuuna yahay null bixinta lacagta macmiilka.

Sense

Dareemayaasha heerkulka, huurka iyo albaabka ee xarumaha go'an.

Dareeme kasta oo deegaanka ah iyo goobta go'an ee uu ilaaliyo: qaboojiye, qol qabow, xarun. Dareemayaashu waxay ku xiriiraan LoRaWAN, markaa waxaa lagu gartaa devEui beddelkii deviceId.

sense:read

Codsi

Jawaab

Xusuusin

place waa null haddii dareemaha nidaamka lagu daray balse aan weli goob lagu xirin. capabilities ayaa sheegaya cabbirrada laga filayo /sense/readings.

Akhrisyada deegaanka, kuwa ugu cusub ayaa ugu horreeya. Ku shaandhee hal dareeme iyo hal cabbir si aad jaantus uga sameyso; iska daa shaandhooyinka si aad u aragto dhammaan xogta.

sense:readbogagga karsarka

Halbeegyada query-ga

devicestringIkhtiyaari
Dareemaha id ee /sense/places.
metricstringIkhtiyaari
temperature, humidity, door ama battery.
limitintegerWaa doorasho
Rafka (rows) bog kasta. Sida caadiga ah waa 100, wuxuuna ku eg yahay 500.
cursorstringWaa doorasho
Waa page.nextCursor ee jawaabtii hore. Ka reeb marka aad eegayso bogga koowaad.

Codsi

Jawaab

Xusuusin

Halbeegyadu waa digrii Salsiyas (Celsius), boqolkiiba huurka, 1 ama 0 ee albaabka (furan ama xiran) iyo bolts (volts) ee batteriga.

Cam

Muuqaallada kamaradda iyo dhacdooyinka badbaadada darawalka, oo ah xogta metadata.

Muuqaallada kamaradda iyo dhacdooyinka badbaadada darawalka (DSM), kuwa ugu cusub ayaa soo horreeya. Xogta metadata oo keliya: maxaa la ogaaday, kanaalkee kamaradeed, xaggee iyo goorma, iyo in muuqaalka la kaydiyay. Muuqaalka laftiisa waxaa laga soo qaadaa konsoolka.

cam:readbogagga karsarka

Halbeegyada query-ga

eventstringIkhtiyaari
Kaliya hal nooc oo dhacdo ah, tusaale ahaan dsm_drowsiness, dsm_phone ama dsm_distraction.
limitintegerWaa doorasho
Rafka (rows) bog kasta. Sida caadiga ah waa 100, wuxuuna ku eg yahay 500.
cursorstringWaa doorasho
Waa page.nextCursor ee jawaabtii hore. Ka reeb marka aad eegayso bogga koowaad.

Codsi

Jawaab

Xusuusin

kind waa dsm_event, periodic ama request; channel waa driver (gudaha u jeeda) ama road. deviceId waa aqoonsiga kamaradda ee /devices. status waa pending, stored, failed ama expired.

Kaarboonka

Muujinta qiiqa Qaybta 1 iyo 2, iyadoo loo eegayo muddada iyo dhaqdhaqaaqa.

Raadka kaarboonka ee la xisaabiyay, midkiiba xilliga warbixinta: Qaybta 1 ee shidaalka gubtay, Qaybta 2 ee korontada la isticmaalay, iyo wadarta. Waxa ay daabacdo warbixinta ESG.

esg:read

Codsi

Jawaab

Xusuusin

status waa computed (socda, wuu isbedeli doonaa marka xilligu buuxsamo), draft ama final. Tirooyinku waa tusaale: waxay isticmaalaan cabbirrada qiiqa ee la daabacay, ee maaha cabbirrada mitirka saxda ah.

Buugga kaarboonka, kuwa ugu cusub ayaa ugu horreeya: dhaqdhaqaaq kasta oo leh qaddarkii lagu cabbiray, cabbirka qiiqa ee la dabaqay iyo halka uu cabbirkaas ka yimid. Wuxuu ku filan yahay inuu soo saaro raad kasta sadar sadar.

esg:readbogagga karsarka

Halbeegyada query-ga

scopestringIkhtiyaari
1 ee gubashada tooska ah ama 2 ee korontada la iibsaday. Wax kasta oo kale waxay soo celinayaan labadaba.
limitintegerWaa doorasho
Rafka (rows) bog kasta. Sida caadiga ah waa 100, wuxuuna ku eg yahay 500.
cursorstringWaa doorasho
Waa page.nextCursor ee jawaabtii hore. Ka reeb marka aad eegayso bogga koowaad.

Codsi

Jawaab

Xusuusin

Qiiqa hal sadar waa quantity × factorValue oo ah kg CO₂e. factorValue waa null halka aan weli cabbir la qoondeynin, sadarradaasna waa laga saaray /carbon/summary.

Warbixinnada

Warbixinta shaqooyinkii dhammaaday, oo wata cabbiraadaha madaxdooda.

Warbixinnadii dhammaaday, kuwa ugu cusub ayaa ugu horreeya. Warbixin kasta oo isticmaaleha shaqeysiiyo ama jadwaleeyo gudaha console-ka waxaa loo hayaa qaab waara oo wata jaangooyooyinkii ay ku shaqeysay iyo halbeegyadeeda muhiimka ah, si aad u qaadato warbixinta safarada habeenkii adoon dib u shaqeysiinin.

reports:readcursor-paginated

Halbeegyada query-ga

limitintegerWaa doorasho
Rafka (rows) bog kasta. Sida caadiga ah waa 100, wuxuuna ku eg yahay 500.
cursorstringWaa doorasho
Waa page.nextCursor ee jawaabtii hore. Ka reeb marka aad eegayso bogga koowaad.

Codsi

Jawaab

Xusuusin

key waa nooca warbixinta: trips, stops, summary, route, events, geofence ama rule_alerts. Kaliya shaqooyinka leh status: done ayaa la soo taxaa. Safafka laftooda waxaa laga soo dejiyaa console-ka.

Caawinta

Cilladaha iyo codsiyada laga soo gudbiyo hantida.

Kiisaska taageerada, kuwa ugu cusub ayaa ugu horreeya: lambarka uu macmiilku ku sheego taleefanka, qaybta, mudnaanta, heerka iyo saacadda SLA. Tani ku muuji miiskaaga si kooxdaadu u aragto isla safka uu arko console-ku.

support:readcursor-paginated

Halbeegyada query-ga

statusstringIkhtiyaari
new, in_progress, on_hold, resolved ama closed.
limitintegerWaa doorasho
Rafka (rows) bog kasta. Sida caadiga ah waa 100, wuxuuna ku eg yahay 500.
cursorstringWaa doorasho
Waa page.nextCursor ee jawaabtii hore. Ka reeb marka aad eegayso bogga koowaad.

Codsi

Jawaab

Xusuusin

category waa connectivity, device, platform ama billing; type waa fault ama request; priority wuxuu u dhexeeyaa P1 ilaa P4. slaDueAt waa null marka kiiska la xaliyo ama halka uusan SLA shaqaynaynin.

Schemas

Object kasta oo v1 soo celiso, iyo xirmada khaladaadka.

Qalab

Waxaa soo celiya /devices iyo /devices/{id}.

deviceIdinteger
Aqoonsi sugan. Kani isticmaal meel kasta oo API-gu ku weydiiyo id.
namestring
Magaca uu arko hawl-wadeenku, badanaa waa taarikada ama tirsiga hantida.
uniqueIdstring
Aqoonsiga uu soo gudbiyo qalabku, badanaa waa IMEI-ga.
stateenum
moving, idle, stopped, offline ama nodata.
customerstring | null
Macmiilka lagu meeleeyay qalabka, haddii uu jiro.
iccidstring | null
SIM-ka lagu xiray qalabka, si loogu isticmaalo taageero iyo xisaab-xir.
protocolstring | null
Decoder-ka maamulaya qalabkan.
lastUpdatedate-time | null
Markii ugu dambeysay ee platform-ku xog ka helo qalabka.

Goobta

Waxaa soo celiya /positions.

deviceIdinteger
Qalabka ay leedahay goobtani.
namestring
Magaca qalabka, kaas oo lagu soo celiyay si maabku uusan ugu baahan raadin labaad.
uniqueIdstring
Aqoonsiga qalabka (hardware).
lat lonnumber | null
Kala-baxa jajab tobanle (Decimal degrees). Waa Null ilaa qalabku ka helo GPS fix.
speedKmhnumber
Xawaaraha dhulka markii ugu dambeysay ee xogta la helay (last fix).
coursenumber
Jihooyinka oo darajooyin ah, 0 ilaa 359.
statestring
Isla qiimayaasha ku jira Qalabka.
ignitionboolean | null
Waa Null meesha uusan qalabku ka soo gudbinin xogta dabka mootada (ignition).
addressstring | null
Waa reverse-geocoded, si tartiib ahna loo buuxiyo. Ha isku hallayn inuu mar kasta joogo.
lastFixdate-time | null
Markii la qaaday xogta GPS (GPS fix).
lastUpdatedate-time | null
Markii uu platform-ku helay.

Dhacdo

Waxaa soo celiya /events.

idstring
Aqoonsi la kala horreysiin karo. Keydi kii ugu cusbaa ee aad soo shaqeysay si aad u sii wadato.
deviceId deviceNameinteger, string
Qalabka ay dhacdadu ka dhacday.
typestring
Nooca mashiinku akhrin karo, tusaale ahaan fuelDrop ama geofenceExit. Kani ku xir shaqadaada, ee haku xirin label.
labelstring
Nooca bini'aadamku akhrin karo ee ka muuqda console-ka.
detailstring | null
Macluumaad dheeri ah haddii xeerku soo saaray.
severityenum
critical, warning, info ama muted.
latitude longitudenumber | null
Meesha ay dhacdadu ka dhacday, markii goobta la ogaa.
occurredAtdate-time
Markii ay dhacdadu dhacday, taas oo ka horreyn karta markii la qoray.
acknowledgedboolean
In hawl-wadeen uu ka tiray console-ka iyo in kale.

Xayndaab

Waxaa soo celiya /geofences.

idstring
Aqoonsiga aagga.
namestring
Magaca ay arkaan hawl-wadeenadu.
kindenum
circle ama polygon. Waxay go'aamisaa qaabka geometry.
geometryobject
Goobadu waa { center: [lon, lat], radius } iyadoo radius-ku yahay mitir. Geesoleydu waa { points: [[lon, lat]] }.
colorstring
Midabka Hex ee loo isticmaalo in lagu sawiro aagga console-ka dhexdiisa.

Asset

Waxa soo celiya /assets.

idstring
Aqoonsiga hantida. U isticmaal /assets/{id}.
registrationstring
Taargada, lambarka ama magaca ay hawlwadeenadu ku gartaan hantida.
typestring
Nooca hantida, tusaale ahaan truck, trailer, container, site, fridge.
mobilityenum
mobile ama fixed, taas oo ku xiran nooca hantida.
make model yearstring | null, string | null, integer | null
Aqoonsiga gaariga haddii la yaqaan.
statusenum
active, maintenance ama retired.
fuelTypestring | null
Shidaalka gaadiidka iyo matoorada, tusaale ahaan diesel, petrol, electric.
attributesobject
Xogaha gaarka u ah noocan hantida ah. Ula dhaqan furayaasha (keys) sida boorso oo kale.
driverIdstring | null
Darawalka hadda loo qoondeeyay.
createdAtdate-time
Xilliga hantida la diiwaangeliyay.

AssetDetail

Waxa soo celiya /assets/{id}.

driverobject | null
{ id, name } ee darawalka loo qoondeeyay.
devicesarray
Qalabka ku xiran: { deviceId, label, type }. deviceId waa null boosaska qalabka ee la qeexay balse aan weli la rakibin.
…
Xogaha kale oo dhami waxay la mid yihiin Asset.

Driver

Waxa soo celiya /drivers.

idstring
Aqoonsiga darawalka.
namestring
Magaca oo buuxa.
email phonestring | null
Xogta xiriirka, haddii la diiwaangeliyay.
licenseNumberstring | null
Lambarka laysanka darawalnimada.
stageenum
draft, invited, in_review, ready, suspended, archived. Waxaa laga soo saaray dukumiintiyada.
statusstring
Waa xog duug ah (legacy). Ha ku salayn shaqadaada.
createdAtdate-time
Xilliga darawalka lagu daray.

Document

Waxa soo celiya /documents.

idstring
Aqoonsiga dukumiintiga.
typestring
Nooca dukumiintiga, tusaale ahaan insurance, licence, photo.
fileName mimeType sizeBytesstring, string | null, integer | null
Wixii la soo geliyay. Xogta bytes lama soo bandhigo.
issueDate expiryDatedate-time | null
Muddada shaqaynta.
statusenum
active ama pending. Dukumiintiyada la diiday lama soo bandhigo.
assetId driverIdstring | null
Hal kaliya ayaa la dejiyaa: mulkiilaha dukumiintiga.
createdAtdate-time
Xilliga la soo geliyay.

MaintenanceTask

Waxa soo celiya /maintenance.

idstring
Aqoonsiga hawsha.
assetIdstring | null
Hantida hawshu ku socoto.
titlestring
Waxa ay tahay hawshu.
kindenum
service, inspection, repair ama other.
statusenum
scheduled, done ama cancelled.
dueDate dueOdometerKmdate-time | null, number | null
Xilliga laga rabo, ha ahaato taariikh, fogaanta kiiloomitirka (odometer), ama labadaba.
completedAt costdate-time | null, number | null
Waxa la buuxiyaa marka la dhammeeyo. Kharashku wuxuu ku baxayaa lacagta macmiilka (tenant).
createdAtdate-time
Xilliga hawsha la abuuray.

Incident

Waxa soo celiya /incidents.

idstring
Aqoonsiga dhacdada.
titlestring
Waxa uu console-ku soo bandhigo.
modulestring
Module-ka kiciyay, tusaale ahaan tracking, fuel, meter, sense.
categorystring | null
Nooca digniinta, tusaale ahaan fuelDrop.
severityenum
critical, warning ama info.
stateenum
open, acknowledged, snoozed ama resolved.
countinteger
Tirada digniinaha lagu soo daray dhacdadan.
deviceId deviceName assetId meterId packIdvarious | null
Mawduuca. Mid ka mid ah id-yada ayaa la dejiyaa, iyadoo ku xiran module-ka.
firstAt lastAtdate-time
Digniintii ugu horreysay iyo tii ugu dambeysay ee kooxda.
resolution resolvedAtstring | null, date-time | null
Sida iyo goorta la xiray.

Rule

Waxaa soo celiyay /rules.

idstring
Aqoonsiga xeerka.
namestring
Sida hawl-wadeenadu u yaqaaniin.
triggerstring
Waxa uu la socdo, tusaale ahaan fuelDrop, geofenceExit, speeding.
deviceIds groupIdsinteger[], string[]
Waxa uu khuseeyo. Labadaba haddii ay eber yihiin waxay ka dhigan tahay dhammaan macmiilka.
geofenceIdstring | null
Kiciyayaasha xayndaabka, aagga.
thresholdobject | null
Settings u gaar ah trigger-ka.
severitystring
Heerka severity ee uu kiciyo.
enabledboolean
Haddii uu hadda shidan yahay.
templateIdstring | null
Waxaa la sameeyaa marka xeerka laga abuuro template-ka buugga.

PowerConsumptionRow

Waxaa soo celiyay /power/consumption.

idstring
Aqoonsiga xariiqda ledger-ka.
occurredAtdate-time
Goorta shidaal shubidda, charge-garaynta, beddelka ama iibka uu dhacay.
kindenum
swap, sale, charge ama fill.
resourceTypestring
diesel, petrol, electricity iyo wixii la mid ah.
directionenum
in (la iibsaday) ama out (la iibiyay ama la bixiyay).
quantity unitnumber, string
Intee in le'eg, L ahaan ama kWh ahaan.
amount currencynumber, string | null
Qiimaha uu ku kacay ama la faa'iiday.
party sitestring | null
Gaadiidka, darawalka ama macmiilka, iyo goobta ay ka dhacday.
statusstring
logged, pending, reconciled, exception, disputed ama dismissed.
methodstring | null
Habka lacag-bixinta ama shidaal shubidda, tusaale ahaan fuel_card, mpesa.

Bogga

Waxaa soo celiyay /power/sites.

id name addressstring, string, string | null
Cabinet-ka.
statusenum
online, degraded ama offline.
feedRefstring | null
Tixraaca cabinet-ka ee telemetry feed-kiisa.
bays ready charging faultinteger
Tirada guud ee bays-ka iyo inta haysa baytari diyaar ah, charge-garoobaya ama cilladaysan.
swapsToday kwhTodayinteger, number
Wax-soo-saarka maanta.

PowerSummary

Waxaa soo celiyay /power/summary.

energyKwh fuelLnumber
Korontada iyo shidaalka la isticmaalay muddadaas.
revenue costnumber
Lacagta baxday iyo lacagta soo gashay, oo ku qoran currency.
swaps costPerSwapinteger, number
Beddelka baytariyada iyo celceliska qiimaha midkiiba.
elecCost fuelCostnumber
Kharashka oo loo qaybiyay nooca khayraadka.
scope2Kg avoidedKgnumber
Qiiqa qiyaasta ah ee ka dhasha charge-garaynta iyo gubista ee laga baaqsaday beddelka dartiis.
currency daysstring, integer
Lacagta iyo dhererka waqtiga la isticmaalay.

Meter

Waxaa soo celiyay /meters.

id serial namestring
Aqoonsiga: id-ga platform-ka, serial-ka warshadda iyo magaca la muujinayo.
engineDeviceIdinteger
Aqoonsiga meter-ka gudaha.
idCodestring | null
Lambarka meter-ka ee ku qoran qalabka.
assetId assetLabelstring | null
Goobta ama dhismaha meter-ku uu adeego.
commsMode endpointstring | null
push ama poll, iyo ciwaanka la eegay marka ay khuseyso.
relayStateenum
connected, disconnected ama unknown.
balancenumber | null
Haraaga prepaid-ka, oo ku qoran lacagta macmiilka.
lastSeenstring | null
Markii ugu dambeysay ee meter-ku xog soo gudbiyo.
statusenum
enrolled, offline ama fault.
liveboolean
Haddii xariiqdani ay ka tarjumayso akhrin cusub oo laga helay meter-ka.

MeterReading

Waxaa soo celiyay /meters/{id}/readings.

idstring
Aqoonsiga akhrinta, oo sidoo kale ah cursor-ka.
obisstring
Diiwaanka (register-ka), tusaale ahaan 1-0:1.8.0.
tsdate-time
Goortii la akhriyay.
valuenumber
Qiimaha register-ka.

Topup

Waxaa soo celiyay /meters/{id}/topups.

idstring
Aqoonsiga lacag-ku-shubista.
modestring
Sida loo bixiyay, tusaale ahaan mpesa, card, ama manual.
amountnumber
Lacagta lagu shubay.
utrnstring | null
Lambarka token-ka ee la siiyay mitirka, haddii uu mid jiray.
statusenum
pending, delivered ama failed.
operatorstring | null
Isticmaalaha nidaamka, ee lacag-ku-shubista gacanta lagu sameeyo (manual).
createdAtdate-time
Goortii la sameeyay.

Place

Waxaa soo celiyay /sense/places.

idstring
Aqoonsiga dareemaha (sensor). U gudbi sidii device xagga /sense/readings.
devEuistring
EUI-ga qalabka ee LoRaWAN.
name modelstring, string | null
Magaca soo muuqanaya iyo nooca qalabka (model).
capabilitiesobject | null
Xogta cabbiraadaha uu dareemuhu soo gudbiyo.
lastSeendate-time | null
Goortii ugu dambeysay ee uu xog soo gudbiyo.
placeobject | null
{ assetId, name, type } ee goobta uu kormeero, ama null haddii aan la meelayn.

SenseReading

Waxaa soo celiyay /sense/readings.

idstring
Aqoonsiga akhrinta, oo sidoo kale ah cursor-ka.
senseDeviceId devEuistring
Dareemaha (sensor).
metricenum
temperature, humidity, door ama battery.
tsdate-time
Goortii la qaaday.
valuenumber
°C, %RH, 1/0 ee albaabka, ama volts.

CamClip

Waxaa soo celiyay /cam/clips.

idstring
Aqoonsiga muuqaalka (clip).
deviceIdinteger | null
Aqoonsiga kamarada ee ku jira /devices.
kindenum
dsm_event, periodic ama request.
eventTypestring | null
Dhacdooyinka DSM, wixii la ogaaday, tusaale ahaan dsm_phone.
channelenum
driver ama road.
capturedAtdate-time
Waqtiga kamarada u gaarka ah.
latitude longitudenumber | null
Halkii uu gaarigu joogay.
driverNamestring | null
Qofkii waday, haddii la yaqaan.
statusenum
pending, stored, failed ama expired.

CarbonSummary

Waxaa soo celiyay /carbon/summary.

id tenantIdstring
Aqoonsiga.
periodStart periodEnd reportingYeardate-time, date-time, integer
Muddada warbixinta.
scope1Kg scope2Kg totalKgnumber
Qiiqa hawada lagu sii daayay oo kg CO₂e ah.
energyKwhnumber
Korontadii la isticmaalay muddadaas.
statusenum
computed, draft ama final.

CarbonEntry

Waxaa soo celiyay /carbon/entries.

idstring
Aqoonsiga diiwaangelinta (entry).
scopeinteger
1 ama 2.
categorystring
Shaqada la qabtay, tusaale ahaan diesel, grid_electricity_ke.
quantity unitnumber, string
Intee in le'eg, L ahaan ama kWh ahaan.
factorValue factorSource factorYearnumber | null, string | null, integer | null
Halbeegga qiiqa la isticmaalay iyo halka uu ka yimid.
createdAtdate-time
Goortii la qoray diiwaangelinta (entry).

Report

Waxaa soo celiyay /reports.

idstring
Aqoonsiga shaqo gelinta (run).
keyenum
trips, stops, summary, route, events, geofence ama rule_alerts.
labelstring
Magacii la siiyay shaqo gelinta (run).
statusstring
Had iyo jeer waa done liiskan dhexdiisa.
rowCountinteger | null
Tirada safafka ee natiijada.
paramsobject | null
Wixii lagu waday: xadka, aaladaha, xayndaab.
metricsobject | null
Tirooyinka guud ee shaqo gelinta.
createdAtdate-time
Goortii ay dhammaatay.

SupportCase

Waxaa soo celiyay /support/cases.

id numberstring
Aqoonsiga iyo lambarka kiiska ee dadku akhriyi karaan.
categoryenum
connectivity, device, platform ama billing.
typeenum
fault ama request.
priorityenum
P1 ilaa P4.
statusenum
new, in_progress, on_hold, resolved ama closed.
titlestring
Wixii lasoo sheegay.
openedAt slaDueAtdate-time, date-time | null
Goortii la furay iyo goorta waqtiga SLA uu dhacayo.

Error

Waxaa lala soo celiyaa xaalad kasta oo ah 4xx.

error.codestring
Mid deggan, oo mashiinku akhriyi karo, tusaale ahaan unauthorized ama forbidden. Tan u adeegso go'aan qaadashadaada.
error.messagestring
Waxaa loo qoray qof akhrinaya log-ga. Qoraalku wuu isbeddeli karaa; code-ku isma beddelayo.