Firmreader Docs Online logo

API-referentie

Bekijk de Firmreader REST API-referentie om posts te maken, kanalen te beheren, met API-sleutels te authenticeren en programmatisch analyses op te vragen.

De Firmreader API is een REST API waarmee je met code programmatisch posts kunt maken, kanalen kunt beheren en analyses kunt opvragen. Probeer onze krachtige API.

Basis-URL

https://api.firmreader.com/v1

Authenticatie

Voor elke aanvraag is een API-sleutel vereist in de header Authorization:

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

API-sleutels worden aangemaakt in Settings > API Keys. Elke sleutel heeft een bereik dat bepaalt waartoe deze toegang heeft:

BereikMachtigingen
posts:readPosts weergeven en ophalen
posts:writePosts maken, bijwerken en verwijderen
channels:readKanalen weergeven en ophalen
channels:writeKanalen maken, bijwerken en verwijderen
analytics:readEngagementstatistieken opvragen

Snelheidslimieten

AbonnementAanvragen per minuut
Starter60
Business300
Enterprise1.000

Headers voor snelheidslimieten zijn opgenomen in elke response:

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

Foutindeling

Alle fouten volgen een consistente indeling:

{
  "error": {
    "code": "invalid_request",
    "message": "The channel_id field is required.",
    "param": "channel_id"
  }
}
HTTP-statusBetekenis
400Ongeldige aanvraag — controleer je parameters
401Niet geautoriseerd — ongeldige of ontbrekende API-sleutel
403Verboden — API-sleutel heeft niet het vereiste bereik
404Niet gevonden — resource bestaat niet
429Snelheidslimiet bereikt — verlaag het tempo
500Serverfout — probeer het later opnieuw

Paginering

List-endpoints retourneren gepagineerde resultaten. Gebruik de parameters cursor en limit:

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

De response bevat een veld next_cursor. Wanneer dit null is, heb je het einde bereikt.

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

Last updated on