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 } }.
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.
Aalad kasta waxay wadataa iccid. RAAD waxay soo tebisaa waxa uu SIM-kaas samaynayo iyadoo la socota hantida lagu xiray, sidaas darteed aaladda la damiyay waa laga sooci karaa midda ishaarada (signal) weyday.
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 iyo /devices/{id}./positions, /positions/history, /sensors iyo /geofences./events, /incidents iyo /rules./assets iyo /assets/{id}./drivers./documents./maintenance./power./meters./sense./cam/clips./carbon./reports./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.
{ data }, iyo { page } marka liisasku yihiin paginated./positions/history marka deviceId, from ama to ay maqan yihiin ama aan la akhriyi karin.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.
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.
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.
Path parameters
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.
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.
Halbeegyada query-ga
Z gadaal.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.
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).
Halbeegyada query-ga
100, wuxuuna ku eg yahay 500.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.
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.
Halbeegyada query-ga
truck, trailer, container, site ama fridge.active, maintenance ama retired.100, wuxuuna ku eg yahay 500.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.
Path parameters
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.
Halbeegyada query-ga
draft, invited, in_review, ready, suspended ama archived.100, wuxuuna ku eg yahay 500.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.
Halbeegyada query-ga
insurance, licence, photo ama nooc uu macmiilku dejiyay.100, wuxuuna ku eg yahay 500.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.
Halbeegyada query-ga
scheduled, done ama cancelled.100, wuxuuna ku eg yahay 500.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.
Halbeegyada query-ga
open, acknowledged, snoozed ama resolved.tracking, fuel, meter ama sense.100, wuxuuna ku eg yahay 500.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.
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).
Halbeegyada query-ga
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.
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.
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.
Halbeegyada query-ga
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.
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.
Path parameters
id) mitirka ee ka yimid /meters.Halbeegyada query-ga
100, wuxuuna ku eg yahay 500.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.
Path parameters
id) mitirka ee ka yimid /meters.Halbeegyada query-ga
100, wuxuuna ku eg yahay 500.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.
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.
Halbeegyada query-ga
id ee /sense/places.temperature, humidity, door ama battery.100, wuxuuna ku eg yahay 500.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.
Halbeegyada query-ga
dsm_drowsiness, dsm_phone ama dsm_distraction.100, wuxuuna ku eg yahay 500.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.
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.
Halbeegyada query-ga
1 ee gubashada tooska ah ama 2 ee korontada la iibsaday. Wax kasta oo kale waxay soo celinayaan labadaba.100, wuxuuna ku eg yahay 500.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.
Halbeegyada query-ga
100, wuxuuna ku eg yahay 500.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.
Halbeegyada query-ga
new, in_progress, on_hold, resolved ama closed.100, wuxuuna ku eg yahay 500.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}.
moving, idle, stopped, offline ama nodata.Goobta
Waxaa soo celiya /positions.
Dhacdo
Waxaa soo celiya /events.
fuelDrop ama geofenceExit. Kani ku xir shaqadaada, ee haku xirin label.critical, warning, info ama muted.Xayndaab
Waxaa soo celiya /geofences.
circle ama polygon. Waxay go'aamisaa qaabka geometry.{ center: [lon, lat], radius } iyadoo radius-ku yahay mitir. Geesoleydu waa { points: [[lon, lat]] }.Asset
Waxa soo celiya /assets.
/assets/{id}.truck, trailer, container, site, fridge.mobile ama fixed, taas oo ku xiran nooca hantida.active, maintenance ama retired.diesel, petrol, electric.AssetDetail
Waxa soo celiya /assets/{id}.
{ id, name } ee darawalka loo qoondeeyay.{ deviceId, label, type }. deviceId waa null boosaska qalabka ee la qeexay balse aan weli la rakibin.Driver
Waxa soo celiya /drivers.
draft, invited, in_review, ready, suspended, archived. Waxaa laga soo saaray dukumiintiyada.Document
Waxa soo celiya /documents.
insurance, licence, photo.active ama pending. Dukumiintiyada la diiday lama soo bandhigo.MaintenanceTask
Waxa soo celiya /maintenance.
service, inspection, repair ama other.scheduled, done ama cancelled.Incident
Waxa soo celiya /incidents.
tracking, fuel, meter, sense.fuelDrop.critical, warning ama info.open, acknowledged, snoozed ama resolved.Rule
Waxaa soo celiyay /rules.
fuelDrop, geofenceExit, speeding.PowerConsumptionRow
Waxaa soo celiyay /power/consumption.
swap, sale, charge ama fill.diesel, petrol, electricity iyo wixii la mid ah.in (la iibsaday) ama out (la iibiyay ama la bixiyay).L ahaan ama kWh ahaan.logged, pending, reconciled, exception, disputed ama dismissed.fuel_card, mpesa.Bogga
Waxaa soo celiyay /power/sites.
online, degraded ama offline.PowerSummary
Waxaa soo celiyay /power/summary.
currency.Meter
Waxaa soo celiyay /meters.
push ama poll, iyo ciwaanka la eegay marka ay khuseyso.connected, disconnected ama unknown.enrolled, offline ama fault.MeterReading
Waxaa soo celiyay /meters/{id}/readings.
1-0:1.8.0.Topup
Waxaa soo celiyay /meters/{id}/topups.
mpesa, card, ama manual.pending, delivered ama failed.Place
Waxaa soo celiyay /sense/places.
device xagga /sense/readings.{ assetId, name, type } ee goobta uu kormeero, ama null haddii aan la meelayn.SenseReading
Waxaa soo celiyay /sense/readings.
temperature, humidity, door ama battery.CamClip
Waxaa soo celiyay /cam/clips.
/devices.dsm_event, periodic ama request.dsm_phone.driver ama road.pending, stored, failed ama expired.CarbonSummary
Waxaa soo celiyay /carbon/summary.
computed, draft ama final.CarbonEntry
Waxaa soo celiyay /carbon/entries.
1 ama 2.diesel, grid_electricity_ke.L ahaan ama kWh ahaan.Report
Waxaa soo celiyay /reports.
trips, stops, summary, route, events, geofence ama rule_alerts.done liiskan dhexdiisa.SupportCase
Waxaa soo celiyay /support/cases.
connectivity, device, platform ama billing.fault ama request.P1 ilaa P4.new, in_progress, on_hold, resolved ama closed.Error
Waxaa lala soo celiyaa xaalad kasta oo ah 4xx.
unauthorized ama forbidden. Tan u adeegso go'aan qaadashadaada.Webhooks iyo write endpoints waxay ku jiraan qorshaha v2. Haddii aad dhisayso wax u baahan midkood, noo sheeg waxa aad dhisayso annagana waxaan kuu sheegi doonnaa halka ay kaga jiraan.