Ga naar hoofdinhoud

API Overview

De Joomla Webservices API is een RESTful API die volgt het JSON:API specificatie formaat.

Base URL​

Alle API requests beginnen met:

https://jouwesite.nl/api/index.php/v1/

Request Formaat​

Headers​

Elke request moet de volgende headers bevatten:

Content-Type: application/json
X-Joomla-Token: JOUW_API_TOKEN

HTTP Methods​

De API gebruikt standaard HTTP methods:

  • GET - Resources ophalen
  • POST - Resources aanmaken
  • PATCH - Resources bijwerken
  • DELETE - Resources verwijderen

Response Formaat​

Alle responses zijn in JSON formaat volgens de JSON:API specificatie.

Succesvolle Response​

{
    "data": [
        {
            "type": "articles",
            "id": "1",
            "attributes": {
                "title": "Artikel titel",
                "alias": "artikel-titel",
                "introtext": "Introductie tekst...",
                "fulltext": "Volledige tekst..."
            }
        }
    ],
    "meta": {
        "total-pages": 5
    }
}

Error Response​

{
    "errors": [
        {
            "status": "404",
            "title": "Resource Not Found",
            "detail": "Het opgevraagde artikel bestaat niet"
        }
    ]
}

HTTP Status Codes​

CodeBetekenis
200Succes
201Resource aangemaakt
204Succes, geen content
400Bad Request
401Niet geautoriseerd
403Verboden
404Niet gevonden
500Server Error

Rate Limiting​

De API heeft rate limiting om misbruik te voorkomen:

  • Standaard: 100 requests per minuut per IP
  • Authenticated: 1000 requests per minuut per token

Rate limit informatie staat in de response headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 998
X-RateLimit-Reset: 1640995200

Paginering​

Grote resultatensets zijn gepagineerd:

GET /api/index.php/v1/content/articles?page[offset]=0&page[limit]=20

Parameters:

  • page[offset]: Start positie (standaard: 0)
  • page[limit]: Aantal items per pagina (standaard: 20, max: 100)

Filtering​

Filter resultaten met de filter parameter:

GET /api/index.php/v1/content/articles?filter[search]=joomla

Beschikbare Endpoints​

Content Management​

Gebruikers & Communicatie​

Site Structuur​

Marketing & Media​

Systeem​

Privacy & Compliance​

Volgende stappen​

Bekijk de specifieke endpoint documentatie voor gedetailleerde informatie over request/response formaten en voorbeelden.