tlha' Doch API mIw

mIw pongHa' pegh-chuqbogh

rItlhwI' bI'elbe'chugh, 'ach browservamDaq lI' tlha' Doch poH qawlu'bogh ghajchugh pagh tlha' Dochvetlh ngaj pegh ngogh qar pagh pegh QR token qengchu'chugh, je DaH Daq update pagh qID DaqonnISchugh, guidevam yIlo'.

mIw yItlhej QonoSta'bogh mIw Qagh reference API docs wa'DIch

core yIpabmeH mIw

tlha' Doch chu'moHlu'ta'nIS. chu'moHlu'be'bogh Dochmey qIDmey je leng mevDaq ghItlhmey lajbe'.
pongHa' write Hoch web leghwI'vam lI' tlha' Doch sessionvo' ghoSnIS pagh tlha' DochvetlhvaD chaw' credential chu' chelnIS.
chaw' credential'e' ngaj pegh ngogh, tlhol QR token, pagh full /trackable/{code} URL 'oHlaH.
pongHa' posts chellaHbogh neH ghItlhbogh ghot'e'. pIq luteqlaH tlha' Doch ghajwI' qoj ghom loHwI'pu' DaH bIH neH.
tlha' Doch ghajwI'pu' je DaH ghom adminpu' moderationmeH qID pagh leng mevDaq Qaw'laH; 'ach latlh nuv ghItlhmey lI'choHlaHbe'.

mIw 1: tlha' Doch yIcher qoj yIghoS

ghItlhghach pa', pongHa' rItlhwI' HochvaD-QobHa' tlha' Doch De' je leng points laDlaHtaH.

POST https://locationnotes.com/api/trackables/lookup
Content-Type: application/json

{
  "code": "LN4C8R2Z"
}

ngogh mach pegh ngogh pagh QR token 'oHchugh, web leghwI'vam lI' pegh-backed poH qawlu'bogh ghajchoH. API writes poH qawlu'boghvetlh lo'laH, pagh rItlhwI' chaw' ngogh poQDI' nobqa'laH.

mIw 2: Dotlh HochvaD Qap DaHbogh yIlaD

GET https://locationnotes.com/api/trackables/{trackableId}
GET https://locationnotes.com/api/trackables/{trackableId}/journey
GET https://locationnotes.com/api/trackables/{trackableId}/comments

payload qIDmey pongHa' client ja': ghItlhghach chaw'lu'', web leghwI' lI' chaw' ghajtaH'a', je posts pongHa' pItlh teqlaH tlha' Doch ghajwI' pagh ghom loHwI'pu' DaHtaHbogh neH.

leng reads polta'bogh mevDaq je currentNotesAtCoordinate cha'ang. DaHjaj same coordinateDaq leghlaHbogh QIn laD model ghaH collectionvam'e', reH wa' QIn lo'lu'bogh mI'na' 'oHbe'.

mIw 3: qID pongHa' yIghItlh

POST https://locationnotes.com/api/trackables/{trackableId}/comments
Content-Type: application/json

{
  "body": "Saw it at the reception desk.",
  "accessCode": "LN4C8R2Z"
}

rItlhwI' ngogh botlh wIvbe'chugh je web leghwI'vetlh tlha' DochvetlhvaD lI' poH qawlu'bogh ghajbe'taHchugh, API botlu'bogh Seng-De' jang nob ghogh: "trackable_access_code_required". ngogh tlha' Doch latlhvaD 'oHchugh pagh DochvamvaD Qapbe'chugh, jang trackable_access_code_invalid lo'.

mIw 4: pu'jIn ja'ghach nIteb pongHa' yIghItlh

POST https://locationnotes.com/api/trackables/{trackableId}/journey-stops
Content-Type: application/json

{
  "latitude": 41.881832,
  "longitude": -87.623177,
  "accessCode": "https://locationnotes.com/trackable/ABCD...<raw or full URL>"
}

mIwvam lightweight pu'jIn-first flow 'oH. QIn chenmoHbe'taHvIS, mevDaq directly tlha' Doch journeyDaq poltaHlu'. pItlh nuv 'elmeH 'ej QIn ngaSbogh Dochmey botlh law' neHchugh, web Daq QIn-chenmoHghach flowDaq ngeHlaH stopvetlhvo'.

client QInmey QaQ

pongHa' flow QaQ law' client limitation DelDI' chugh sounding threateningbe'. pattern QaQ naDev:

ta' Daghajbe'taHvIS je DaghItlhlaH.
pIq pongHa' choHmey choHlu'be' qoj teqlu'be',
ach poQchugh, tlha' Doch ghajwI' pagh ghom adminpu' SeHlaH.

lo'wI' pItlh choHghach pagh QIn choHghach neHchugh, QIn qonta'meH yI'el rur secondary action yInob, 'elmeH wa'DIch tIchmoHQo'.

ghItlhlu'ta' pIq

mevDaq qoj qID chu' client cha'vaD reH, leng endpointmey je qID endpointmey yIchu'qa'.

GET https://locationnotes.com/api/trackables/{trackableId}/journey
GET https://locationnotes.com/api/trackables/{trackableId}/comments

naDghach je Say'moHghach

pongHa' qIDmey je pongHa' leng mevDaqmey tlha' Doch naQvaD ratlhtaH, Hoch write authorization botlh tlha' Dochvetlh lI' poH qawlu'bogh pagh chaw' credential lo'lu'mo'.
exportmeyDaq recordmeyvetlh tu'lu'; pong Hutlhbogh/authenticated flags QIjlu'chu'.
tlha' Doch exportmey je retention flows polta'bogh mevDaq snapshotmey je QIn-rarwI' QonoSmey ngoD pImmey mojmoHlaH, vaj pIq QIn choHmey He qun qan choHmoHbe'.
QaghwI' mojbogh ghot tu'lu'chugh, ghajwI'pu' je DaH taHbogh ghom adminpu' je recordmeyvetlh Qaw'chu'laH.

rItlhwI'vetlh QInDaj ghaj qoj choHqangta'chugh, pa'Daq ghoSmoH tlha' Doch mIw QonoSta'bogh. jangmey lajbe'lu'boghvaD yIlo' tlha' Doch Qagh reference.