Nasusubaybayan ang Daloy ng API

Anonymous na sikretong-backed na daloy

Gamitin ang gabay na ito kapag hindi magsa-sign in ang tumatawag ngunit mayroon itong aktibong trackable session ng browser o pisikal na hawak ang eksaktong maikling secret code ng trackable o pribadong QR token at kailangang mag-iwan ng update sa lokasyon o komento kaagad.

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

Mga pangunahing panuntunan

Dapat ay naka-activate na ang trackable. Tinatanggihan ng mga hindi na-activate na item ang mga komento at pagsusulat ng journey-stop.
Ang bawat anonymous na pagsusulat ay dapat magmula sa aktibong trackable session ng browser na ito o kasama ang eksaktong kredensyal sa pag-access para sa partikular na trackable na iyon.
Ang kredensyal sa pag-access ay maaaring ang maikling sikretong code, ang raw na QR token, o ang buong /trackable/{code} URL.
Ang mga anonymous na post ay add-only para sa taong lumikha sa kanila. Tanging ang nasusubaybayang may-ari o kasalukuyang mga admin ng team ang maaaring mag-alis sa kanila sa ibang pagkakataon.
Maaaring mag-moderate ang mga nasusubaybayang may-ari at kasalukuyang admin ng team sa pamamagitan ng pagtanggal ng komento o paghinto sa paglalakbay, ngunit hindi nila maaaring i-edit ang nilalaman ng ibang tao.

Hakbang 1: Resolbahin o bisitahin ang trackable

Mababasa pa rin ng isang hindi kilalang tumatawag ang masusubaybayang data at mga punto ng paglalakbay na ligtas sa publiko bago mag-post.

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

{
  "code": "LN4C8R2Z"
}

Kung ang code ay isang maikling lihim o QR token, ang browser ay nakakakuha ng aktibong secret-backed session. Maaaring gamitin ng API writes ang aktibong session na iyon, o maaaring ipadala muli ng tumatawag ang access code kapag kinakailangan.

Hakbang 2: Basahin ang kasalukuyang pampublikong ligtas na estado

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

Sinasabi ng payload ng mga komento sa isang hindi kilalang kliyente na pinapayagan ang pag-post, kung mayroon nang aktibong access ang browser, at ang mga hindi kilalang post ay maaalis lang sa ibang pagkakataon ng nasusubaybayang may-ari o kasalukuyang mga admin ng koponan.

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.

Hakbang 3: Mag-post ng anonymous na komento

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

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

Kung ang tumatawag ay ganap na tinanggal ang code at ang browser ay hindi pa nagdadala ng aktibong session para sa parehong trackable, ang API ay nagbabalik ng isang ipinagbabawal na tugon sa mga detalye ng problema na may code: "trackable_access_code_required." Kung ang code ay kabilang sa isa pang trackable o mali ang pagkakabuo para sa item na ito, ang tugon ay gumagamit ng trackable_access_code_invalid.

Hakbang 4: Mag-post ng hindi kilalang direktang ulat sa mapa

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

Ito ang magaan na mapa-unang daloy. Direktang iniimbak ang stop sa trackable na paglalakbay nang hindi gumagawa ng tala. Kung magsa-sign in ang tao sa ibang pagkakataon at gusto ng mas mahusay na nilalaman ng tala, maaaring ipadala sila ng website sa daloy ng paggawa ng tala mula sa paghintong iyon.

Magiliw na pagmemensahe ng kliyente

Pinakamahusay na gagana ang anonymous na daloy kapag ipinaliwanag ng kliyente ang limitasyon nang hindi nagbabanta. Ang isang magandang pattern ay:

Maaari mong i-post ito nang walang account.
Ang mga anonymous na update ay hindi maaaring i-edit o alisin sa ibang pagkakataon,
ngunit maaaring i-moderate sila ng nasusubaybayang may-ari o mga admin ng team kung kinakailangan.

Kung gusto ng user ang pag-edit o pag-convert ng tala sa hinaharap, mag-alok ng pangalawang pagkilos tulad ng Pag-login upang mag-iwan ng tala sa halip na pilitin ang pag-sign-in sa harap.

Pagkatapos magpost

I-refresh ang paglalakbay at mga endpoint ng komento para maipakita kaagad ng kliyente ang bagong post na paghinto o komento.

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

Pag-moderate at paglilinis

Ang mga anonymous na komento at anonymous na paghinto sa paglalakbay ay nakatali pa rin sa isang partikular na masusubaybayan dahil ang bawat pagsusulat ay pinahihintulutan ng aktibong session o pag-access ng kredensyal ng trackable na iyon.
Kasama sa mga pag-export ang mga talaan na may tahasang anonymous/na-authenticate na mga flag.
Maaaring panatilihin ng mga nasusubaybayang pag-export at daloy ng pagpapanatili ang mga naka-save na stop snapshot at talaan ng link ng tala bilang magkahiwalay na mga katotohanan upang ang mga pag-edit ng tala sa ibang pagkakataon ay hindi muling isulat ang naunang kasaysayan ng ruta.
Kung may lalabas na masamang aktor, maaaring permanenteng alisin ng mga may-ari at kasalukuyang admin ng team ang mga apektadong record.

Kapag handa na ang tumatawag na pagmamay-ari o i-edit ang kanilang pino-post, ilipat siya sa napatunayang nasusubaybayan na daloy. Para sa mga negatibong tugon, gamitin ang nasusubaybayang sanggunian ng error.