Nasusubaybayan ang Daloy ng API

Na-authenticate na nasusubaybayan na daloy

Gamitin ang gabay na ito kapag nakahanap ang isang tao ng masusubaybayan, naabot ang daloy ng lihim na pag-access, nag-sign in, at pagkatapos ay gustong gawin ang mas mahusay na pagmamay-ari o ihinto ang daloy ng trabaho na sinusuportahan ng tala nang hindi nawawala ang mas simpleng opsyon sa direktang ulat.

Sundin ang pagkakasunod-sunod Pangunahing API docs Anonymous na daloy Sanggunian ng error

Kailan gagamitin ang daloy na ito

Ito ang pinakamagandang daloy para sa mga taong gustong matibay ang pagmamay-ari, nae-edit na mga komento, conversion ng tala, kapangyarihan sa pagmo-moderate, o ang kakayahang bumalik sa ibang pagkakataon at pamahalaan ang kanilang nai-post. Maaaring magsimula ang tao mula sa isang lihim na code o QR token bago mag-login, ngunit kapag na-authenticate na nila, hindi na nila kailangang ipagpatuloy ang pagpapadala ng access code sa bawat pagsulat.

Hakbang 1: Resolbahin ang nahanap na item

Ang maikling ruta ng pagpasok sa website ay palaging /trackable/{code}. API Ang mga kliyente ay maaari ring direktang lutasin ang token.

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"
}

Kung ang usesSecretAccess ay totoo, ang browser ay mayroon na ngayong aktibong secret-backed session para sa trackable na iyon. Ang session na iyon ay hiwalay sa pag-sign-in at partikular na umiiral para ang user ay maaaring magpatuloy muna sa masusubaybayang daloy ng trabaho.

Hakbang 2: Basahin ang aktibong-session na landing payload

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

Sinasabi nito sa kliyente kung kinakailangan pa rin ang pag-activate, kung ang item ay kabilang sa isang grupo, at kung aling mga konteksto ng pag-activate ang available pagkatapos mag-sign in.

Hakbang 3: Mag-sign in at i-activate kapag kinakailangan

Kung hindi pa rin aktibo ang item, mag-log in at i-activate ito sa isang personal na may-ari o isang team.

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
}

Kung ang item ay nagmula sa isang grupo, ang pag-activate ay din kung saan nakumpirma ang panghuling pagkakakilanlan sa antas ng item. Maaaring magpadala ang mga kliyente ng tahasang pangalan, paglalarawan, at mga halaga ng statusMessage o iwanan ang mga ito na blangko habang ginagamit ang useGroupDefaultTitle, useGroupDefaultDescription, at useGroupDefaultStatusMessage upang panatilihin ang mga kasalukuyang default ng grupo sa na-activate na item.

Maaaring opsyonal na isama ng mga kliyente ang <code>initialJourneyStopLatitude</code> plus <code>initialJourneyStopLongitude</code> kapag ang activation ay dapat ding gumawa kaagad ng unang sinusubaybayang lokasyon.

Hakbang 4: Pumili sa pagitan ng simple at masaganang logging path

Kapag na-authenticate, magagamit pa rin ng kliyente ang lightweight na direktang-ulat na landas o ang mas mahusay na landas ng tala. Ang dalawang landas ay komplementaryo, hindi kapwa eksklusibo.

Simpleng landas: lumikha ng direktang paghinto sa paglalakbay gamit ang POST /api/trackables/{trackableId}/journey-stops.
Rich path: gumawa muna ng tala, pagkatapos ay i-attach ang trackable sa note through POST /api/public/notes/{noteId}/trackables.
Website-only na conversion path: ang isang naka-sign-in na user ay maaaring mag-convert ng sarili nilang direktang lokasyon-lang na stop sa isang tala sa ibang pagkakataon nang hindi nadodoble ang segment ng ruta.

Hakbang 5A: Mag-save ng direktang paghinto sa paglalakbay

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

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

Ang naka-save na stop ay isang hindi nababagong snapshot ng logistik. Kung gumagalaw ang isang naka-link na tala sa ibang pagkakataon, pinapanatili ng paglalakbay ang orihinal na na-snap na coordinate upang hindi tahimik na magbago ang kasaysayan ng ruta.

Hakbang 5B: Gumawa ng tala at ilakip ang nasusubaybayan

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"
}

Ang pag-attach ng trackable habang sine-save ang tala ay nagre-record din ng journey-stop snapshot sa sandaling iyon. Ang paghintong iyon na may suporta sa tala ay siyang nagpoprotekta sa masusubaybayang landas kung magbabago ang sariling punto ng mapa ng tala sa ibang pagkakataon.

Binibigyan din ng note attachment ang kinakailangang saklaw ng access ng tala sa nasusubaybayang iyon. Ang paghinto ay nagpapanatili ng kasaysayan ng lugar, ngunit ang pag-access sa tala ay ipinapatupad pa rin ng sariling visibility at mga panuntunan sa saklaw ng tala.

Hakbang 6: Magkomento bilang isang napatotohanang user

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

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

Ang mga naka-sign-in na nasusubaybayang komento ay maaaring i-edit lamang ng naka-sign-in na may-akda ng komento. Maaaring tanggalin ng mga may-ari at kasalukuyang admin ng team ang mga komento o paghinto ng paglalakbay, ngunit hindi pa rin nila maisusulat na muli ang mga salita ng ibang tao.

Hakbang 7: Basahin ang kumpletong ruta at mga komento

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

Ang journey payload ay naayos na ayon sa pagkakasunod-sunod at na-preload na para sa pag-render ng mapa. Kung ang paghinto ay nagmula sa isang pribadong tala na hindi mabubuksan ng manonood, maaari pa ring ilantad ng API ang punto ng lokasyon habang inaalis ang protektadong nilalaman ng tala.

Ang pagbabasa ng Paglalakbay ay inilalantad ang naka-save na paghinto kasama ang kasalukuyangNotesAtCoordinate. Ang koleksyon na iyon ay ang nakikitang note read model ngayon para sa parehong coordinate, hindi patunay na permanenteng nagmamay-ari ng isang note ang stop.

Mga tala sa pagpapatakbo

Kung gusto ng isang naka-sign in na user ang simpleng over-map flow, hayaan silang gamitin ito. Dapat alisin ng authentication ang friction, hindi pilitin ang ibang UI.
Kasama na ngayon sa mga pag-export ng user at team ang mga trackable journey stop, history stop na suportado ng tala, at mga nasusubaybayang komento.
Ang pagtanggal ng isang account ay hindi awtomatikong tatanggalin ang buong trackable kung umaasa pa rin ang ibang tao o isang team sa kasaysayan nito.

Mga kaugnay na sanggunian: Ano ang isang Trackable?, anonymous na trackable na daloy, at nasusubaybayang sanggunian ng error.