Palaute omassa sovelluksessasi
DropComments SDK
Kerää palautetta suoraan rakentamassasi sovelluksessa yhdellä skriptitagilla, yhdellä palvelimesi päätepisteellä ja omalla Palaute-painikkeellasi. Tiimisi merkitsee kommentin, laatikon tai piirroksen suoraan sovellukseen, ja käyttäjät lähettävät palautetta lyhyellä lomakkeella. Kaikki päätyy projekteihisi tänne, missä sinä ja tekoälyagenttisi voitte vastata.
Asenna SDKAloita ilmaiseksi. Sovelluksesi avain pysyy palvelimellasi.
Sovelluksesta annettavan palautteen ei pitäisi alkaa kuvakaappauksesta
Kun sovelluksesi testaaja huomaa jotain, hän ottaa kuvakaappauksen, rajaa sen, liittää sen keskusteluun ja kirjoittaa ”se juttu ylhäällä toisessa näkymässä”. Sinä etsit näkymän ja arvaat, mitä hän tarkoittaa.
Kun skripti on sovelluksessa, testaaja osoittaa suoraan oikeaa kohtaa. Kommentin mukana tulee kuva näkymästä sellaisena kuin se oli, kyseinen kohta merkittynä sekä lähettäjän tiedot. Sinä tai koodausagentti voitte ryhtyä korjaamaan sitä, ja vastaus näkyy sovelluksessa.
Näin se toimii
- 1
Lisää sovelluksesi
Lisää tilisi Sovellukset-osiossa sovelluksen nimi, osoitteet, joissa se toimii, ja projektit, joihin palaute ohjataan. Voit valita esimerkiksi yhden tiimillesi ja toisen asiakkaillesi. Sovellus saa oman avaimen.
- 2
Lisää skripti
Sovelluksen palvelin säilyttää avaimen ja antaa sivulle lyhytikäisen tokenin kirjautuneelle käyttäjälle. Token kertoo myös, kuuluuko käyttäjä tiimiisi. Sivu lataa yhden skriptitagin, ja oma Palaute-painikkeesi avaa palautetoiminnon. Kopioi DropCommentsin näyttämät ohjeet sovellustasi rakentavalle agentille, niin se lisää tarvittavat osat.
- 3
Palautetta alkaa tulla
Tiimisi painaa Palaute-painiketta, merkitsee kohdan ja kirjoittaa kommentin. He näkevät kaikkien kommenttimerkit sovelluksessa ja jokaisen vastauksen reaaliajassa. Kaikille muille avautuu lyhyt lomake. Jokainen palaute päätyy projektissaan olevan Dropin näkymäksi.
Asenna SDK
Verkkosovellukselle, jolla on palvelin ja kirjautuvia käyttäjiä. Asennettavaa pakettia ei ole: tarvitset avaimen palvelimellesi, päätepisteen, joka antaa sivulle tokenin, skriptitagin ja oman painikkeen, joka avaa palautetoiminnon.
Lisää sovelluksesi DropCommentsin Sovellukset-osiossa: sen nimi, osoitteet, joissa se toimii (https tai kehityksen aikana http localhost- ja .test-osoitteissa), ja projektit, joihin palaute ohjataan. Saat sovelluksen avaimen ja kunkin projektin tunnisteen.
Säilytä avain palvelimellasi, ympäristömuuttujissa tai salaisuuksien säilössä:
DROPCOMMENTS_KEY=dc_app_…
Älä koskaan sijoita sitä sivulle, selaimeen päätyvään koodiin tai commitiin. DropComments ei hyväksy avainta selaimesta.
Lisää token-päätepiste. Se pyytää DropCommentsilta tokenin kirjautuneelle käyttäjälle ja palauttaa sen JSON-vastauksen sellaisenaan. Jos kukaan ei ole kirjautunut, palauta 401, jolloin mitään ei näytetä.
// 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"}}); }Toteutettu Next.js-reittikäsittelijänä. Sama toimii Workerissa, Denossa tai Bunissa. Palauta Expressissä sama tilakoodi ja JSON.
Lataa skripti jokaisella sivulla ennen tagia
</body>:<script src="https://dropcomments.com/live.js" data-token-url="/api/feedback-token"></script>
Skripti ei luo omaa painiketta, joten mitään ei vielä näy.
Lisää oma Palaute-painikkeesi, joka pysyy piilossa, kunnes
DropComments.readykertoo tokenin saapuneen. Painike avaa tiimillesi paneelin ja kaikille muille lyhyen lomakkeen:<button id="feedback" hidden>Feedback</button> const button = document.getElementById("feedback"); if (await DropComments.ready) { button.hidden = false; button.addEventListener("click", () => DropComments.open()); }Sijoita se sovellukseesi sopivaan paikkaan: ylätunnisteeseen, valikkoon tai asetusnäkymään. Skripti luo paneelin, lomakkeen ja kommenttimerkit.
Jos sivusi lähettävät Content-Security-Policy-otsakkeen, salli DropComments:
script-src https://dropcomments.com; connect-src https://dropcomments.com wss://dropcomments.com;
Tai anna koodausagenttisi hoitaa se. Kun lisäät sovelluksesi, saat ohjeen, jossa avain ja projektien tunnisteet ovat jo mukana. Kopioi se sovellustasi rakentavalle agentille, niin se lisää päätepisteen, skriptin ja painikkeen.
Tekninen viite
Token
Palvelimesi kutsuu osoitetta POST https://dropcomments.com/api/app/token käyttäen sovelluksen avainta bearer-tokenina. project on pakollinen, ja sen arvoksi annetaan projektin tunniste. user on kirjautunut käyttäjä. Jos jätät nimen pois, paneeli kysyy sitä. team määrittää, mitkä työkalut käyttäjä saa. Token on voimassa tunnin, ja skripti pyytää päätepisteeltäsi uuden ennen sen vanhenemista.
{
"project": "YOUR_PROJECT_ID",
"user": {"id": "u_123", "name": "Sam Lee"},
"team": true
}
// → {"token": "dct.…", "expiresAt": …, "team": true, "project": {…}}Skriptin asetukset
data-token-url on päätepisteesi, johon pyyntö tehdään sivun evästeillä. Se voi palauttaa tokenin JSON-muodossa tai pelkkänä tekstinä. data-ui="none" ei näytä mitään, jotta voit käyttää omaa lomakettasi: lähetä sen keräämät tiedot kutsulla DropComments.send(). Tietokoneella lähetettyihin tiimin kommentteihin liitetään kuvan lisäksi kopio sivusta. Dropissa sivupainike näyttää kopion, jota voi vierittää ja jonka tekstiä voi valita. Agentti voi lukea sen tekstin. data-capture="picture" lähettää vain kuvan. Puhelimet ja tabletit lähettävät aina vain kuvan.
<script src="https://dropcomments.com/live.js" data-token-url="/api/feedback-token" data-capture="picture"></script>
JavaScript
Kaikki löytyy oliosta window.DropComments, kun skripti on latautunut. ready kertoo, saapuiko token, joten näytät painikkeesi vasta silloin.
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 nullSovelluksesi ulkoasu
Voit muotoilla Palaute-painikkeesi vapaasti. Määritä nämä kohteelle :root, niin myös paneeli, lomake ja kommenttimerkit käyttävät niitä. Muut muuttujat: --dc-muted, --dc-line, --dc-soft, --dc-on-accent, --dc-accent-text, --dc-pin, --dc-on-pin ja --dc-button-radius.
:root {
--dc-font: "Inter", sans-serif;
--dc-surface: #ffffff;
--dc-text: #111827;
--dc-accent: #4f46e5;
--dc-radius: 12px;
}Tietojen pitäminen yksityisinä
Kommentin mukana tulee kuva näkymästä, joten siinä näkyy näkymän sisältö, myös kirjoitettu teksti (salasanat pisteinä). Merkitse sisältö, joka ei saa koskaan poistua sovelluksestasi, niin se näkyy kuvassa harmaana laatikkona ja jätetään pois sivun kopiosta. Kopiossa ei ole skriptejä, ja tekstikentät jätetään tyhjiksi.
<div data-dc-hide> Card ending 4242 </div>
Mitä saat
Tiimisi testaamassa versiota
Lisää kommenttimerkki, laatikko tai piirros toimivaan sovellukseen tietokoneella tai puhelimella. Jokaisen kommentin mukana tulee kuva näkymästä ja merkitty kohta sekä tietokoneelta myös kopio sivusta. Siksi ”tässä on vika” riittää.
Sovelluksesi käyttäjät
Lyhyt lomake, jossa on Osoita kohta -toiminto ja kuva näkymästä. Käyttäjät eivät koskaan näe muiden palautetta, ja kuva lähetetään vain, jos he jättävät sen valituksi.
Betatestaajat ja asiakkaat
Anna sovellusta kanssasi kokeilevien kirjautua sisään ja päätä, ketkä kuuluvat tiimiin. Testiympäristön sivustoa arvioiva asiakas voi jättää huomionsa suoraan sivulle.
Agentti korjaa
DropCommentsiin yhdistetty koodausagentti lukee jokaisen kommentin ja sivun, jolla se tehtiin, tekee muutoksen ja vastaa. Vastaus näkyy sovelluksessa.
Sovelluksesi näköinen
Käyttäjien lomake saa värisi, fonttisi ja kulmiensa muodon muutamasta CSS-muuttujasta. Voit myös käyttää omaa lomakettasi ja lähettää sen tiedot yhdellä kutsulla.
Avaimesi pysyy sinulla
Avain säilytetään palvelimellasi, ei koskaan sivulla. Palautetta vastaanotetaan vain sovelluksesi osoitteista, sen määrää rajoitetaan käyttäjäkohtaisesti ja jokainen projekti valitaan tunnisteen perusteella.
Suoraan Saapuneet-näkymään
Jokainen palaute saapuu tikettinä projektinsa Saapuneet-näkymään, valmiina jonkun otettavaksi.
Kysymyksiä
Toimiiko se missä tahansa sovelluksessa?
Missä tahansa verkkosovelluksessa, jolla on palvelin ja kirjautuvia käyttäjiä: palvelin kertoo DropCommentsille, kuka kukin käyttäjä on. Myös pelit ja muut canvasille piirretyt sovellukset toimivat. Niissä piirtoalue välittyy kuvana.
Mitä tiimin kommentin mukana lähetetään?
Kuva näkymästä sellaisena kuin se oli. Kaikki data-dc-hide-merkinnällä merkityt kohdat näkyvät harmaina. Tietokoneella mukaan tulee myös kopio sivusta kuvan rinnalle (ellet aseta data-capture="picture"): tyylit ja kuvat sisältyvät siihen, mutta skriptit eivät. Täytetyt kentät jäävät tyhjiksi ja data-dc-hide-merkinnällä merkityt kohdat jätetään pois. Mukaan tulee myös kuva kommentoidusta kohdasta. Drop näyttää kuvan, ja tietokoneella voi vaihtaa sivunäkymään. Skripti piirtää kuvan sivun asettelun pohjalta, joten se on lähellä alkuperäistä mutta ei täysin tarkka: muunnokset, suodattimet ja ::before- tai ::after-sisältö näkyvät pelkistetyssä muodossa. Näkymään tallentuu myös tieto siitä, missä se luotiin: sivun osoite (ilman #fragment-osaa), otsikko, ikkunan koko ja selain.
Voinko pitää asiakkaiden ja tiimin palautteen erillään?
Kyllä. Sovellus voi lähettää palautetta useaan projektiin, ja sen palvelin määrittää kunkin henkilön kohdalla projektin. Näin tiimin palaute menee yhteen projektiin ja muiden toiseen.
Mitä se maksaa?
Ominaisuus sisältyy kaikkiin paketteihin. Ilmaispaketissa kukin palautetta keräävä Drop on avoinna päivän, minkä jälkeen alkaa uusi. Pro pitää ne avoinna.
Lue lisää
Kokeile seuraavalla tiedostollasi
Saat linkin noin kymmenessä sekunnissa.
Pudota tiedosto