DropComments

Maklum balas dalam aplikasi anda

SDK DropComments

Terima maklum balas dalam aplikasi yang anda bina dengan satu tag skrip, satu titik akhir pada pelayan anda dan butang Maklum balas anda sendiri. Pasukan anda menyemat komen, kotak atau lukisan terus pada aplikasi, manakala penggunanya menghantar maklum balas melalui borang ringkas. Semuanya masuk ke projek anda di sini, tempat anda dan ejen AI anda membalas.

Pasang SDK

Percuma untuk bermula. Kunci aplikasi anda kekal pada pelayan anda.

Maklum balas tentang aplikasi tak sepatutnya bermula dengan tangkapan skrin

Apabila seseorang yang menguji aplikasi anda menemui sesuatu, mereka mengambil tangkapan skrin, memangkasnya, menampalnya dalam sembang dan menulis “benda di atas, pada skrin kedua”. Anda pun mencari skrin itu dan meneka benda yang dimaksudkan.

Dengan skrip dalam aplikasi, mereka menunjuk terus pada tempatnya. Komen diterima bersama gambar skrin ketika itu, lokasi yang ditandakan dan identiti pengirim, supaya anda atau ejen pengekodan boleh terus membaikinya. Balasannya pula muncul dalam aplikasi.

Cara ia berfungsi

  1. 1

    Tambah aplikasi anda

    Dalam akaun anda, di bawah Aplikasi: masukkan namanya, alamat tempat ia berjalan dan projek yang akan menerima maklum balasnya, contohnya satu untuk pasukan anda dan satu untuk pelanggan anda. Aplikasi itu akan mendapat kunci.

  2. 2

    Tambah skrip

    Pelayan aplikasi menyimpan kunci dan memberikan halaman token jangka pendek untuk sesiapa yang sedang log masuk, dengan menyatakan sama ada mereka ahli pasukan anda. Halaman memuatkan satu tag skrip, dan butang Maklum balas anda sendiri membukanya. Tampalkan arahan yang dipaparkan oleh DropComments kepada ejen yang membina aplikasi anda, dan ejen itu akan menambah semuanya.

  3. 3

    Maklum balas diterima

    Pasukan anda menekan Maklum balas, menyematkannya pada lokasi berkenaan dan menulis; mereka melihat pin semua orang pada aplikasi serta setiap balasan, secara langsung. Orang lain mendapat borang ringkas. Setiap maklum balas diterima sebagai skrin dalam Drop di projeknya.

Pasang SDK

Untuk aplikasi web yang mempunyai pelayan dan pengguna yang log masuk. Tiada pakej untuk dipasang: hanya kunci pada pelayan anda, titik akhir yang memberikan token kepada halaman, tag skrip dan butang anda sendiri untuk membukanya.

  1. Tambah aplikasi anda dalam DropComments, di bawah Aplikasi: namanya, alamat tempat ia berjalan (https, atau http pada localhost dan .test semasa pembangunan) dan projek yang akan menerima maklum balasnya. Anda akan mendapat kunci aplikasi dan id setiap projek.

    Tambah aplikasi anda

  2. Simpan kunci pada pelayan anda, dalam pemboleh ubah persekitaran atau stor rahsianya:

    DROPCOMMENTS_KEY=dc_app_…

    Jangan sekali-kali letakkannya dalam halaman, kod yang dihantar ke pelayar atau komit. DropComments menolak kunci yang dihantar daripada pelayar.

  3. Tambah titik akhir token. Untuk sesiapa yang sedang log masuk, titik akhir itu meminta token daripada DropComments dan mengembalikan JSON yang diterima tanpa perubahan. Jika tiada sesiapa log masuk, balas dengan 401 dan tiada apa-apa akan dipaparkan.

    // 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"}});
    }

    Ditulis sebagai pengendali laluan Next.js; caranya sama dalam Worker, Deno atau Bun. Dalam Express, kembalikan status dan JSON yang sama.

  4. Muatkan skrip pada setiap halaman, sebelum </body>:

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

    Skrip ini tidak memaparkan butangnya sendiri, jadi tiada apa-apa yang kelihatan lagi.

  5. Tambah butang Maklum balas anda sendiri, sembunyikannya sehingga DropComments.ready menunjukkan token telah diterima, untuk membuka panel bagi pasukan anda dan borang ringkas bagi orang lain:

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

    Letakkannya di tempat yang sesuai dalam aplikasi anda: pengepala, menu atau skrin tetapan. Panel, borang dan pin disediakan oleh skrip.

  6. Jika halaman anda menghantar Content-Security-Policy, benarkan DropComments:

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

Atau biarkan ejen pengekodan anda melakukannya. Selepas anda menambah aplikasi, arahan ringkas dipaparkan dengan kunci dan id projek anda sudah diisi; tampalkannya kepada ejen yang membina aplikasi anda, dan ejen itu akan menambah titik akhir, skrip dan butang.

Rujukan

Token

Pelayan anda memanggil POST https://dropcomments.com/api/app/token dengan kunci aplikasi sebagai token pembawa. project wajib diisi dengan id projek. user ialah sesiapa yang sedang log masuk; jika nama tidak disertakan, panel akan memintanya. team menentukan alat yang mereka dapat. Token sah selama sejam, dan skrip meminta token baharu daripada titik akhir anda sebelum tempohnya tamat.

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

Pilihan skrip

data-token-url ialah titik akhir anda, yang diakses menggunakan kuki halaman; ia boleh membalas dengan JSON token atau token sebagai teks biasa. data-ui="none" tidak memaparkan apa-apa, supaya anda boleh menggunakan borang sendiri: hantar maklumat yang dikumpulkannya dengan DropComments.send(). Jika dihantar dari komputer, komen pasukan disertakan salinan halaman selain gambar: dalam Drop, butang halaman memaparkan salinan itu, yang boleh ditatal dan teksnya boleh dipilih, serta ejen boleh membaca perkataannya. data-capture="picture" menghantar gambar sahaja. Telefon dan tablet sentiasa menghantar gambar sahaja.

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

JavaScript

Semuanya tersedia pada window.DropComments selepas skrip dimuatkan. ready menunjukkan sama ada token telah diterima, jadi paparkan butang anda hanya selepas itu.

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

Rupa aplikasi anda

Anda bebas menggayakan butang Maklum balas anda. Tetapkan nilai ini pada :root dan panel, borang serta pin turut menggunakannya. Yang selebihnya: --dc-muted, --dc-line, --dc-soft, --dc-on-accent, --dc-accent-text, --dc-pin, --dc-on-pin dan --dc-button-radius.

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

Menjaga privasi

Komen disertakan gambar skrin, jadi gambar itu menunjukkan kandungan skrin, termasuk teks yang ditaip (kata laluan dipaparkan sebagai titik). Tandakan apa-apa yang tidak boleh sekali-kali keluar daripada aplikasi anda; ia akan menjadi kotak kelabu dalam gambar dan tidak disertakan dalam salinan halaman. Salinan itu tidak mengandungi skrip dan medan yang ditaip dibiarkan kosong.

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

Apa yang anda dapat

Pasukan anda, menguji binaan

Sematkan pin, lukis kotak atau buat lukisan pada aplikasi semasa ia berjalan, di komputer atau telefon. Setiap komen disertakan gambar skrin dengan lokasi ditandakan, serta salinan halaman jika dihantar dari komputer, jadi “ada masalah di sini” sudah memadai.

Pengguna aplikasi

Borang ringkas dengan pilihan Tunjuk lokasinya dan gambar skrin. Mereka tidak akan melihat maklum balas orang lain, dan gambar mereka hanya dihantar jika kotaknya dibiarkan bertanda.

Penguji beta dan klien

Minta mereka yang mencuba aplikasi anda log masuk dan tentukan siapa yang dikira sebagai ahli pasukan. Klien yang menyemak laman pementasan boleh meninggalkan nota terus pada laman itu.

Dibaiki oleh ejen

Ejen pengekodan yang disambungkan ke DropComments membaca setiap komen dan halaman tempat komen itu dibuat, membuat perubahan dan membalas. Balasan muncul dalam aplikasi.

Mengikut rupa aplikasi anda

Borang pengguna mengikut warna, fon dan bentuk bucu anda melalui beberapa pemboleh ubah CSS, atau gunakan borang anda sendiri dan hantarkannya dengan satu panggilan.

Kunci anda kekal milik anda

Kunci disimpan pada pelayan anda, tidak sekali-kali dalam halaman. Maklum balas hanya diterima daripada alamat aplikasi anda, dihadkan bagi setiap orang, dan setiap projek dipilih melalui idnya.

Terus ke Peti masuk anda

Setiap maklum balas masuk sebagai tiket dalam Peti masuk projeknya, sedia untuk diambil oleh seseorang.

Soalan

Adakah ia berfungsi dengan semua aplikasi?

Mana-mana aplikasi web yang mempunyai pelayan dan pengguna yang log masuk: pelayan memberitahu DropComments identiti setiap orang. Permainan dan aplikasi lain yang dilukis pada kanvas juga berfungsi; papan dihantar sebagai gambar.

Apakah yang dihantar bersama komen pasukan?

Gambar skrin seperti keadaannya ketika itu, dengan apa-apa yang anda tandakan data-dc-hide dikelabukan. Dari komputer, salinan halaman turut disertakan di sebelahnya (melainkan anda menetapkan data-capture="picture"): lengkap dengan gaya dan gambarnya tetapi tanpa skrip, dengan medan yang ditaip dibiarkan kosong dan apa-apa yang ditandakan data-dc-hide dikecualikan, serta gambar lokasi tersebut. Drop memaparkan gambar itu, dan pada komputer, anda boleh beralih kepada halaman tersebut. Gambar itu dilukis oleh skrip berdasarkan susun atur halaman, jadi hasilnya hampir sama tetapi tidak tepat sepenuhnya: transformasi, penapis dan kandungan ::before atau ::after dipaparkan dalam bentuk biasa. Skrinnya juga menyimpan butiran tempat ia dibuat: alamat halaman (tanpa #fragment), tajuknya, saiz tetingkap dan pelayar.

Bolehkah saya mengasingkan maklum balas pelanggan dan pasukan?

Ya. Aplikasi boleh menghantar maklum balas ke beberapa projek, dan pelayannya menentukan projek untuk setiap orang, jadi maklum balas pasukan masuk ke satu projek dan maklum balas orang lain ke projek yang lain.

Berapakah kosnya?

Ciri ini tersedia dalam semua pelan. Dalam pelan percuma, setiap Drop maklum balas dibuka selama sehari, dan Drop baharu bermula selepas itu; Pro membiarkannya terus dibuka.

Teruskan membaca

Cuba dengan fail anda yang seterusnya

Hanya sekitar sepuluh saat untuk mendapatkan pautan.

Letakkan fail