DropComments

Відгуки у вашому застосунку

DropComments SDK

Збирайте відгуки в застосунку, який створюєте: достатньо одного тегу script, одного ендпоінта на вашому сервері та власної кнопки «Відгук». Команда залишає коментарі, виділяє ділянки рамками чи малює просто в застосунку, а користувачі надсилають відгуки через коротку форму. Усе потрапляє до ваших проєктів тут, де ви та ваш ШІ-агент можете відповідати.

Установити SDK

Почніть безкоштовно. Ключ вашого застосунку залишається на вашому сервері.

Відгук про застосунок не має починатися зі знімка екрана

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

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

Як це працює

  1. 1

    Додайте свій застосунок

    У своєму обліковому записі в розділі «Застосунки» вкажіть його назву, адреси, за якими він працює, та проєкти для відгуків — наприклад, один для команди, інший для клієнтів. Застосунок отримає ключ.

  2. 2

    Додайте скрипт

    Сервер застосунку зберігає ключ і видає сторінці короткочасний токен для користувача, який увійшов, із зазначенням, чи належить він до вашої команди. Сторінка завантажує один тег script, а ваша кнопка «Відгук» відкриває інтерфейс. Скопіюйте те, що покаже DropComments, і передайте агенту, який створює ваш застосунок, — він усе додасть.

  3. 3

    Надходять відгуки

    Команда натискає «Відгук», позначає потрібне місце й пише коментарі; усі позначки та відповіді видно просто в застосунку наживо. Решта користувачів бачать коротку форму. Кожен відгук потрапляє до свого проєкту як екран у Drop.

Установіть SDK

Для вебзастосунку із сервером і входом для користувачів. Установлювати пакет не потрібно: лише ключ на вашому сервері, ендпоінт, який видає сторінці токен, тег script і власна кнопка, що відкриває інтерфейс.

  1. Додайте свій застосунок у DropComments у розділі «Застосунки»: вкажіть назву, адреси, за якими він працює (https або http на localhost і .test під час розробки), та проєкти для його відгуків. Ви отримаєте ключ застосунку й ідентифікатор кожного проєкту.

    Додайте свій застосунок

  2. Зберігайте ключ на своєму сервері, у змінних середовища або сховищі секретів:

    DROPCOMMENTS_KEY=dc_app_…

    Ніколи не розміщуйте його на сторінці, у коді, який потрапляє до браузера, чи в коміті. DropComments не приймає цей ключ із браузера.

  3. Додайте ендпоінт токенів. Він запитує в DropComments токен для користувача, який увійшов, і повертає отриманий JSON без змін. Якщо ніхто не ввійшов, повертайте 401 — тоді нічого не відображатиметься.

    // GET /api/feedback-token
    export async function GET(request) {
      const user = await getSignedInUser(request); // your own sign-in
      if (!user) return new Response(null, {status: 401});
    
      const res = await fetch("https://dropcomments.com/api/app/token", {
        method: "POST",
        headers: {
          authorization: `Bearer ${process.env.DROPCOMMENTS_KEY}`,
          "content-type": "application/json",
        },
        body: JSON.stringify({
          project: "YOUR_PROJECT_ID",
          user: {id: user.id, name: user.name},
          team: user.isStaff, // true: pin comments on the app. false: the short form
        }),
      });
      return new Response(res.body, {status: res.status, headers: {"content-type": "application/json"}});
    }

    Приклад написано як обробник маршруту Next.js; у Worker, Deno чи Bun усе так само. В Express повертайте той самий статус і JSON.

  4. Завантажуйте скрипт на кожній сторінці перед </body>:

    <script src="https://dropcomments.com/live.js" data-token-url="/api/feedback-token"></script>

    Власної кнопки скрипт не додає, тож поки нічого не відображатиметься.

  5. Додайте власну кнопку «Відгук» і приховуйте її, доки DropComments.ready не повідомить, що токен отримано. Кнопка відкриватиме панель для команди й коротку форму для решти користувачів:

    <button id="feedback" hidden>Feedback</button>
    
    const button = document.getElementById("feedback");
    if (await DropComments.ready) {
      button.hidden = false;
      button.addEventListener("click", () => DropComments.open());
    }

    Розмістіть її там, де зручно у вашому застосунку: у шапці, меню чи на екрані налаштувань. Панель, форму й позначки додає скрипт.

  6. Якщо ваші сторінки надсилають Content-Security-Policy, дозвольте DropComments:

    script-src https://dropcomments.com;
    connect-src https://dropcomments.com wss://dropcomments.com;

Або доручіть це своєму агенту для програмування. Після додавання застосунку ви побачите інструкцію, у якій уже є ваш ключ та ідентифікатори проєктів. Передайте її агенту, який створює ваш застосунок, — він додасть ендпоінт, скрипт і кнопку.

Довідка

Токен

Ваш сервер викликає POST https://dropcomments.com/api/app/token, передаючи ключ застосунку як Bearer-токен. Поле project обов’язкове: у ньому вказується ідентифікатор проєкту. user — користувач, який увійшов; якщо не вказати ім’я, панель попросить його ввести. team визначає, які інструменти будуть доступні користувачу. Токен діє годину, і до завершення цього терміну скрипт запитує новий у вашого ендпоінта.

{
  "project": "YOUR_PROJECT_ID",
  "user": {"id": "u_123", "name": "Sam Lee"},
  "team": true
}
// → {"token": "dct.…", "expiresAt": …, "team": true, "project": {…}}

Параметри скрипту

data-token-url — ваш ендпоінт, до якого запит надсилається з файлами cookie сторінки; він може повертати JSON із токеном або токен як звичайний текст. data-ui="none" повністю приховує інтерфейс, щоб ви могли використати власну форму: надсилайте зібрані нею дані через DropComments.send(). Коментарі команди з комп’ютера містять копію сторінки разом зі знімком: у Drop кнопка сторінки відкриває цю копію з прокручуванням і текстом, який можна виділяти, а агент може читати її текст. data-capture="picture" надсилає лише знімок. Телефони й планшети завжди надсилають лише знімок.

<script src="https://dropcomments.com/live.js"
  data-token-url="/api/feedback-token"
  data-capture="picture"></script>

JavaScript

Після завантаження скрипту все доступне через window.DropComments. ready повідомляє, чи отримано токен, тож показуйте кнопку лише після цього.

await DropComments.ready; // true once a token came
DropComments.open();  // the team’s panel, or everyone else’s form
DropComments.close();
await DropComments.send({text: "The total is wrong", picture: true});
await DropComments.link(); // the team’s feedback in DropComments, or null

Стиль вашого застосунку

Ви самі визначаєте вигляд своєї кнопки «Відгук». Задайте ці змінні для :root, і панель, форма та позначки теж їх використовуватимуть. Решта змінних: --dc-muted, --dc-line, --dc-soft, --dc-on-accent, --dc-accent-text, --dc-pin, --dc-on-pin і --dc-button-radius.

:root {
  --dc-font: "Inter", sans-serif;
  --dc-surface: #ffffff;
  --dc-text: #111827;
  --dc-accent: #4f46e5;
  --dc-radius: 12px;
}

Захист приватних даних

Коментар містить знімок екрана, тож на ньому видно все, що є на екрані, зокрема введений текст (паролі — крапками). Позначте все, що ніколи не має залишати ваш застосунок: на знімку це буде сірий прямокутник, а до копії сторінки воно не потрапить. У копії немає скриптів, а поля введення залишаються порожніми.

<div data-dc-hide>
  Card ending 4242
</div>

Що ви отримуєте

Ваша команда тестує збірку

Ставте позначки, виділяйте ділянки рамками чи малюйте просто в запущеному застосунку з комп’ютера або телефона. Кожен коментар містить знімок екрана з позначеним місцем, а з комп’ютера — ще й копію сторінки, тож достатньо написати «тут не працює».

Користувачі застосунку

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

Бета-тестувальники й клієнти

Надайте вхід людям, з якими тестуєте застосунок, і визначте, хто належить до команди. Клієнт, який перевіряє тестову версію сайту, залишає нотатки просто на ньому.

Виправляє агент

Агент для програмування, підключений до DropComments, читає кожен коментар і сторінку, на якій його залишили, вносить зміни та відповідає. Відповідь з’являється в застосунку.

У стилі вашого застосунку

Форма для користувачів переймає ваші кольори, шрифт і заокруглення кутів із кількох CSS-змінних. Або використовуйте власну форму й надсилайте дані одним викликом.

Ваш ключ залишається у вас

Ключ зберігається на вашому сервері й ніколи не потрапляє на сторінку. Відгуки приймаються лише з адрес вашого застосунку, з обмеженням для кожного користувача, а кожен проєкт вибирається за ідентифікатором.

Просто у «Вхідні»

Кожен відгук надходить як завдання у «Вхідні» свого проєкту — можна одразу братися до роботи.

Запитання

Це працює з будь-яким застосунком?

З будь-яким вебзастосунком, у якому є сервер і вхід для користувачів: сервер повідомляє DropComments, хто є хто. Ігри та інші застосунки, намальовані на canvas, теж працюють — їхнє полотно передається як знімок.

Що надсилається разом із коментарем учасника команди?

Знімок екрана на момент створення, на якому все позначене data-dc-hide зафарбовано сірим. Якщо відгук надіслано з комп’ютера, поруч також буде копія сторінки (якщо ви не вказали data-capture="picture"): з її стилями й зображеннями, без скриптів, із порожніми полями введення та без усього, що позначено data-dc-hide, а також знімок конкретного місця. Drop показує знімок, а на комп’ютері можна перемкнутися на сторінку. Скрипт малює знімок на основі компонування сторінки, тому він схожий на оригінал, але не точний: трансформації, фільтри та вміст ::before або ::after відображаються без цих ефектів. Екран також зберігає дані про те, де його створено: адресу сторінки (без її #fragment), заголовок, розмір вікна та браузер.

Чи можна відокремити відгуки клієнтів від відгуків команди?

Так. Застосунок може надсилати відгуки в кілька проєктів, а його сервер визначає проєкт для кожної людини. Так відгуки команди потрапляють в один проєкт, а всіх інших — в інший.

Скільки це коштує?

Це доступно на всіх тарифах. На безкоштовному тарифі кожен Drop із відгуками відкритий протягом доби, після чого створюється новий; з Pro вони залишаються відкритими.

Читайте далі

Спробуйте з наступним файлом

Отримати посилання можна приблизно за десять секунд.

Перетягніть файл