tlha' Doch API mIw

tlha' Doch mIw QonoSta'bogh

nuv wa' tlha' Doch SamDI', pegh-chaw' flowDaq pawDI', 'elmeH ta'DI', ghIq ghajghach law' qoj QInmo' Qapbogh mevDaq mIw lo' neHchugh 'ach nIt-ja'ghach option QatlhHa' botlh Qaw'be' neHchugh, paqvam yIlo'.

mIw yItlhej API docs wa'DIch mIw pongHa' Qagh reference

mIwvam yIlo'meH poH

mIwvam nIv law' ghajghach taHbogh, qIDmey choHlaHbogh, QIn choHmoH, SeHnuDghach HoS, pagh pItlh cheghqa'taHvIS ghItlhlu'ta'boghpu'bogh SeH DaneHbogh nuvpu'vaD. nuvvetlh 'elmeH pa' pegh ngogh pagh QR tokenvo' taghlaH, 'ach authenticateDI' chaw' ngogh Hoch write botlh ngeHqa'nISbe'.

mIw 1: Doch tu'lu'bogh yIcher

ngaj web Daq qonta' He reH /trackable/{code} 'oH. API clients token directly resolve-laH je.

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

{
  "code": "LN4C8R2Z"
}
{
  "found": true,
  "trackableId": "f3a8f841-20db-4f1e-a3f8-9f14bc0b3c31",
  "isPublicCodeMatch": false,
  "usesSecretAccess": true,
  "redirectUrl": "/en-US/trackables/active/f3a8f841-20db-4f1e-a3f8-9f14bc0b3c31"
}

usesSecretAccess teH 'oHchugh, web leghwI'vam tlha' DochvetlhvaD lI' pegh-backed poH qawlu'bogh ghaj. poH qawlu'boghvetlh 'elmeH rapbe' je lo'wI' wa'DIch tlha' Doch mIw tlhejtaHmeH neH chenmoHlu'.

mIw 2: poH qawlu'bogh payload taHbogh yIlaD

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

clientvaD SovmoH: chu'moHghach poQtaH'a', Doch ghomDaq chel'', je 'elmeH pIq chu'moH context nuq tu'lu'.

mIw 3: bIQonoS 'ej poQDI' yIchu'moH

Doch chu'moHlu'be'taHchugh, bI'el 'ej ghajwI' nIteb qoj teamvaD yIchu'moH.

POST https://locationnotes.com/api/trackables/{trackableId}/activate
Authorization: Bearer <access token>
Content-Type: application/json

{
  "name": "",
  "description": "",
  "statusMessage": "",
  "useGroupDefaultTitle": true,
  "useGroupDefaultDescription": true,
  "useGroupDefaultStatusMessage": true,
  "teamId": null,
  "externalLinkUrl": "",
  "externalLinkDescription": "",
  "useGroupDefaultExternalLink": true,
  "initialJourneyStopLatitude": 47.6205,
  "initialJourneyStopLongitude": -122.3493
}

Doch ghomvo' ghoSchugh, chu'moHghachDaq Doch-patlh identity qav wI'ol. clients explicit pong, Delghach, je statusMessage lo'lu'bogh De'mey noblaH qoj blank poltaHvIS useGroupDefaultTitle, useGroupDefaultDescription, je useGroupDefaultStatusMessage lulo'laH, chu'moHlu'ta'bogh itemDaq ghom motlhmey DaHtaHbogh polmeH.

chu'moHghach Daq wa'DIch SIbI' chenmoHnISchugh, clients <ngogh>initialJourneyStopLatitude</code> je <ngogh>initialJourneyStopLongitude</code> chellaH.

mIw 4: QatlhHa' logging He je rich logging He botlh yIwIv

authenticatelu'DI' pIqaD, client lightweight nIt-ja'ghach He pagh QIn He botlh law' lo'taHlaH. cha' pathmeyvam complementary 'oH; mutually exclusive 'oHbe'.

step 5a: yIpol nIt leng mevDaq

POST https://locationnotes.com/api/trackables/{trackableId}/journey-stops
Authorization: Bearer <access token>
Content-Type: application/json

{
  "latitude": 41.8819,
  "longitude": -87.6278
}

mevDaq polta'bogh immutable logistics snapshot 'oH. rarlu'bogh QIn pItlh movechoHchugh, leng Quv snapped wa'DIch poltaH, vaj He history peghchoHtaHvIS choHbe'.

step 5b: yIchenmoH QIn je attach tlha' Doch

POST https://locationnotes.com/api/notes/mine
Authorization: Bearer <access token>
Content-Type: application/json

{
  "categoryId": "4de6bb76-f25d-4c73-b8e3-81b9ca3bf08f",
  "title": "North lobby handoff",
  "body": "Visible as a note and as a trackable stop.",
  "latitude": 41.8818,
  "longitude": -87.6231,
  "visibility": "Private"
}
POST https://locationnotes.com/api/public/notes/{noteId}/trackables
Authorization: Bearer <access token>
Content-Type: application/json

{
  "trackableSecretCodes": "LN4C8R2Z"
}

poltaHvIS noteDaq tlha' Doch Dararchugh, poHvamDaq leng mevDaq snapshot je qonlu'. QInmo' Qapbogh mevDaqvetlh'e' QIn pu'jIn Daq choHqa'chugh tlha' Doch He Hub.

QIn attachment je QIn poQlu'bogh chaw' laH tlha' Doch'e' nob je. place history pol mevDaq, 'ach QIn leghlaHghach laH pabmey'e' QIn chaw' SeHtaH.

mIw 6: lo'wI' QonoSta'bogh DaH yIcomment

POST https://locationnotes.com/api/trackables/{trackableId}/comments
Authorization: Bearer <access token>
Content-Type: application/json

{
  "body": "Picked up and moving again."
}

tlha' Doch qIDmey chenbogh 'elta'bogh ghItlhwI' neH editlaH. ghajwI'pu' je ghom adminpu' DaH taHbogh qIDmey qoj leng mevDaqmey Qaw'laH, 'ach latlh mu'mey chu'laHbe'.

step 7: laD naQmoH He je qIDmey

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

leng De'ghom chronologirItlhy HablI'lu'ta' je mapvaD qanglu'ta'. mevDaqvetlh QIn peghvo' ghertlhu'chugh, leghwI' poSlaHbe'chugh je, API Daq point cha'laHtaH 'ach QIn De' Hubta'bogh lanbe'.

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'.

Qapghach ghItlhmey

reference'mey botlh: nuq 'oH tlha' Doch'e'?, tlha' Doch mIw pongHa', je tlha' Doch Qagh reference.