API

Una visió general de l'API REST de Feedjolt: JSON sobre HTTPS amb token bearer. Cobreix la URL base, la referència interactiva, convencions i la versió v1.

L'API de Feedjolt és una API REST sobre JSON. La referència completa d'endpoints està en progrés; aquesta secció cobreix els comportaments que s'apliquen a tots els endpoints.

URL base

https://api.feedjolt.com/api/v1

Referència interactiva

La referència completa d'endpoints, amb try-it, viu a:

https://api.feedjolt.com/docs

S'autogenera des del servei FastAPI - sempre actualitzada. El JSON OpenAPI 3.x és a https://www.feedjolt.com/openapi.json (també a https://api.feedjolt.com/openapi.json). YAML: https://www.feedjolt.com/api/openapi.yaml.

El que hi ha en aquestes pàgines

Els comportaments transversals que s'apliquen a cada endpoint:

Autenticació - claus API, on posar el bearer token.
Límits de peticions - capçaleres, 429 i Retry-After.
Errors - forma de l'error, codis, què reintentar.
Paginació - basada en pàgina, amb totals.

Per al detall per endpoint (forma del cos de petició, paràmetres de query, esquema de resposta), la referència interactiva de dalt és la font de veritat.

El que ve

SDKs propis - TypeScript i Python.

Vota al full de ruta públic si et desbloquejaria.

Tast ràpid

Una crida típica:

curl -H "Authorization: Bearer fjk_LA_TEVA_CLAU" \
     -H "Content-Type: application/json" \
     "https://api.feedjolt.com/api/v1/boards/feature-requests/posts?per_page=10"

Resposta:

{
  "items": [
    { "id": "post_abc", "title": "Add dark mode", "votes": 42, "status": "Planificat" }
  ],
  "page": 1,
  "per_page": 10,
  "total": 213,
  "total_pages": 22
}

Estat

Recurs	CRUD	Notes
Posts	✅	List, get, create, update, delete, merge.
Comentaris	✅	List, get, create, update, delete. Scope de comentari intern requerit per a interns.
Vots	✅	List, cast (toggle).
Taulers	✅ read, ⚠️ write	Crear/editar taulers via panell per ara.
Estats	✅
Etiquetes	✅
Membres	✅	List, invite, change role, remove.
Webhooks	✅	Endpoints, lliuraments, replay.
Claus API	✅	List + revoke (creació és només del panell).
Espais	⚠️ read	Configuració de l'espai via panell.
Facturació	❌	Només panell.

Convencions

Temps són ISO 8601, UTC, sufix Z.
IDs són strings curts amb prefix: post_abc, cmt_xyz, evt_qrs. Mai enters.
Slugs són identificadors estables aptes per a URL (espai, tauler, etiqueta). Prefereix-los per a URLs visibles.
Booleans són JSON true/false, no strings.
Nullables fan servir null, no claus omeses, quan es documenta.
Llistes buides són [], no null.

Versionat

/api/v1 és la versió actual. No trencarem v1 - llançarem v2 a una nova ruta quan necessitem fer canvis trencadors. Les addicions de camps a v1 són no-trencadores i poden passar en qualsevol moment.

On this page