Потік API, що відстежується

Анонімний секретний потік

Скористайтеся цим посібником, якщо абонент не входитиме, але має активний сеанс відстеження цього веб-переглядача або фізично має точний короткий секретний код трекованого об’єкта чи приватний QR-токен і йому потрібно негайно оновити місцезнаходження або залишити коментар.

Дотримуйтеся послідовності Автентифікований потік Посилання на помилку Основні документи API

Основні правила

Трекований об’єкт має бути вже активований. Неактивовані елементи відхиляють коментарі та записи про зупинку подорожі.
Кожен анонімний запис має надходити з активного трекованого об’єкта сеансу цього браузера або містити точні облікові дані доступу для цього конкретного трекованого об’єкта.
Обліковими даними для доступу може бути короткий секретний код, необроблений QR-токен або повна URL-адреса /trackable/{code}.
Анонімні публікації є додатковими лише для особи, яка їх створила. Лише трекований об’єкт власник або поточні адміністратори команди можуть видалити їх пізніше.
Трековані об’єкти власники та поточні адміністратори команди можуть модерувати, видаливши коментар або зупинку подорожі, але вони не можуть редагувати чужий вміст.

Крок 1: Вирішіть або відвідайте трекований об’єкт

Анонімний клієнт усе ще може читати публічно безпечні дані трекованого об’єкта та точки маршруту перед публікацією.

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

{
  "code": "LN4C8R2Z"
}

Якщо код є коротким секретом або QR-токеном, браузер отримує активний секретний сеанс. Запис API може використовувати цей активний сеанс, або абонент може повторно надіслати код доступу за потреби.

Крок 2: Прочитайте поточний загальнодоступний стан

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

Корисне навантаження коментарів повідомляє анонімному клієнту, що публікація дозволена, чи має веб-переглядач уже активний доступ і що анонімні публікації можуть бути видалені пізніше лише трекованим об’єктом власником або поточними адміністраторами команди.

Читання маршруту показують збережену зупинку разом із currentNotesAtCoordinate. Ця колекція є поточною моделлю читання видимих нотаток для тієї самої координати, а не доказом того, що зупинка назавжди володіє однією нотаткою.

Крок 3: Опублікуйте анонімний коментар

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

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

Якщо клієнт повністю пропускає код, а браузер ще не має активного сеансу для того самого трекера, API повертає заборонену відповідь problem-details із кодом "trackable_access_code_required". Якщо код належить іншому трекеру або має неправильний формат для цього елемента, відповідь використовує trackable_access_code_invalid.

Крок 4: Опублікуйте анонімний прямий звіт на карті

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

Це легкий процес, який починається з мапи. Зупинка зберігається безпосередньо в маршруті трекованого об’єкта без створення нотатки. Якщо людина пізніше ввійде й захоче додати багатший вміст нотатки, вебсайт може перейти з цієї зупинки до процесу створення нотатки.

Дружній обмін повідомленнями клієнта

Анонімний потік працює найкраще, коли клієнт пояснює обмеження без погроз. Хороший шаблон:

Ви можете опублікувати це без облікового запису.
Анонімні оновлення не можна редагувати або видалити пізніше,
, але власник трекованого об’єкта або адміністратори команди можуть модерувати їх за потреби.

Якщо користувач бажає майбутнього редагування або перетворення нотаток, запропонуйте допоміжну дію, як-от «Вхід», щоб залишити нотатку замість примусового входу в обліковий запис.

Після публікації

Оновіть кінцеві точки подорожі та коментарів, щоб клієнт міг негайно показати щойно опубліковану зупинку чи коментар.

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

Модерація та очищення

Анонімні коментарі й анонімні зупинки маршруту все одно прив'язані до конкретного трекера, бо кожен запис авторизується активним сеансом цього трекера або його обліковими даними доступу.
Експорт включає ті записи з явними анонімними прапорцями /authenticated.
Експорт трекованих об’єктів і сценарії зберігання можуть тримати збережені знімки зупинок і записи зв’язку з нотатками як окремі факти, щоб пізніші редагування нотаток не переписували ранню історію маршруту.
Якщо з’являється зловмисник, власники та поточні адміністратори команди можуть назавжди видалити відповідні записи.

Коли абонент готовий володіти або редагувати те, що він публікує, перемістіть його до автентифікований трекований об’єкт потік. Для негативних відповідей використовуйте довідник помилок трекера.