Quickstart

Instal·la el widget de Feedjolt, crea una clau API i rep el teu primer webhook en un túnel local. Guia ràpida de 10 min per a desenvolupadors; omet el que no usis.

Estat final: botó de feedback al teu lloc, una crida a l'API funcionant des del teu terminal i un webhook arribant a un túnel a localhost. Salta les parts que no necessitis.

Requisits

Un espai de Feedjolt. Registra't si no en tens un.
El teu slug d'espai - la part de la URL. És a Panell -> Configuració -> General.
10 minuts.

Enganxa això abans de </body> a qualsevol pàgina del teu lloc:

<script async src="https://www.feedjolt.com/widget-loader.js"
        data-workspace="EL_TEU_SLUG_D_ESPAI"></script>

Recarrega la pàgina. Hauries de veure un botó "Feedback" flotant a la cantonada inferior dreta.

Fes clic; el widget s'obre. Envia un post de prova. Hauria d'aparèixer al teu panell a Panell -> Taulers -> [el teu tauler per defecte] en segons.

2. Aconsegueix una clau API (3 min)

Panell -> Configuració -> Claus API -> Nova clau.

Posa un nom honest: local-dev-marc, no key.
Scopes: comença amb scopes de només lectura.
Copia la clau quan es mostri. Comença amb fjk_. No la veuràs un altre cop.

Prova-la (substitueix EL_TEU_SLUG_DE_TAULER per un dels teus taulers):

curl -H "Authorization: Bearer fjk_LA_TEVA_CLAU" \
  "https://api.feedjolt.com/api/v1/boards/EL_TEU_SLUG_DE_TAULER/posts?limit=5"

Hauries de rebre JSON amb fins a 5 posts. Si reps 401, la clau és incorrecta o revocada. Si 403, el scope és massa estret.

La referència completa d'endpoints és a https://api.feedjolt.com/docs.

3. Rep un webhook (5 min)

Per a dev local, necessitaràs un túnel. Recomanem ngrok o Cloudflare Tunnel.

ngrok http 3000
# -> https://abc123.ngrok-free.app

Al teu codi, accepta peticions POST:

// Node + Express
import express from "express";
const app = express();
app.use(express.json());

app.post("/feedjolt-webhook", (req, res) => {
  console.log("event:", req.headers["x-feedjolt-event"]);
  console.log("body:", req.body);
  res.status(200).send("ok");
});

app.listen(3000);

A Feedjolt: Panell -> Configuració -> Webhooks -> Nou endpoint.

URL: https://abc123.ngrok-free.app/feedjolt-webhook
Esdeveniments: tria uns quants (per exemple, post.created, status.changed).
Fes clic a Desar. Copia el secret de firma.

Dispara un esdeveniment enviant un post de feedback (fes servir el widget que acabes d'instal·lar). En uns 5 segons, el teu endpoint hauria de rebre un POST.

La verificació de firma és essencial abans de passar a producció. Veure Webhooks: firma.

4. Neteja

Revoca la clau API en acabar les proves: Configuració -> Claus API -> Revocar.
Elimina l'endpoint de webhook de prova: Configuració -> Webhooks -> Eliminar.
Elimina els posts de prova: obre el post -> Eliminar, o fes servir l'API.

El que ve després

Configuració del widget - els cinc atributs data-*.
Firma de webhooks - verifica que les peticions són realment nostres.
Referència API - cada endpoint, amb try-it.

Si alguna cosa d'aquesta guia no ha funcionat, reporta el bug - volem que aquesta guia sigui sense fricció.