Riferimento API

L'API di Firmreader è un'API REST che consente di creare post, gestire canali e interrogare le analisi tramite codice. Prova la nostra potente API.

URL di base

https://api.firmreader.com/v1

Ogni richiesta richiede una chiave API nell'intestazione Authorization:

curl https://api.firmreader.com/v1/posts \
  -H "Authorization: Bearer fr_live_abc123"

Le chiavi API vengono create in Settings > API Keys. Ogni chiave ha un ambito che limita ciò a cui può accedere:

Ambito	Autorizzazioni
`posts:read`	Elencare e recuperare i post
`posts:write`	Creare, aggiornare ed eliminare post
`channels:read`	Elencare e recuperare i canali
`channels:write`	Creare, aggiornare ed eliminare canali
`analytics:read`	Interrogare le metriche di coinvolgimento

Le intestazioni dei limiti di frequenza sono incluse in ogni risposta:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 297
X-RateLimit-Reset: 1708790400

Tutti gli errori seguono un formato coerente:

{
  "error": {
    "code": "invalid_request",
    "message": "The channel_id field is required.",
    "param": "channel_id"
  }
}

Stato HTTP	Significato
400	Richiesta non valida — controlla i parametri
401	Non autorizzato — chiave API non valida o mancante
403	Vietato — la chiave API non dispone dell'ambito richiesto
404	Non trovato — la risorsa non esiste
429	Limite di frequenza raggiunto — rallenta le richieste
500	Errore del server — riprova più tardi

Gli endpoint di elenco restituiscono risultati paginati. Usa i parametri cursor e limit:

curl "https://api.firmreader.com/v1/posts?limit=20&cursor=post_abc123" \
  -H "Authorization: Bearer fr_live_abc123"

La risposta include un campo next_cursor. Quando è null, hai raggiunto la fine.

{
  "data": [...],
  "next_cursor": "post_xyz789",
  "has_more": true
}