API-documentatie

Koppel je eigen toepassing aan gebruikers, forumgegevens en statistieken van One2xs.

Beheer je API-sleutels

Aan de slag

Je eerste verzoek

Maak een API-sleutel aan in je accountinstellingen. Voeg die bij elk verzoek toe als X-API-Key of als Authorization: Bearer header.

Alle v1-data-endpoints zijn alleen-lezen en verwachten GET over HTTPS. Forumgegevens, recente berichten en forumstatistieken volgen de categorierechten van de eigenaar van de sleutel.

De gebruikersroutes geven alleen een beperkte set profielvelden terug. E-mailadressen, wachtwoorden, wachtwoordhashes, IP-adressen, locaties, handtekeningen en exacte tijdstippen van laatste activiteit worden niet als profielvelden verstrekt.

Basis-URL: https://www.one2xs.com/api/v1

Voorbeeld
curl "https://www.one2xs.com/api/v1/users?per_page=10" \
  -H "X-API-Key: one2xs_your_api_key_here" \
  -H "Accept: application/json"

Je ziet de sleutel alleen bij het aanmaken. Bewaar hem als geheim op je server, bijvoorbeeld in een omgevingsvariabele. Is hij gelekt? Verwijder de sleutel in je account en maak een nieuwe aan.

Gebruikers

Forum

Statistieken

Antwoorden en fouten

Antwoorden gebruiken JSON. Controleer de HTTP-status en het veld success in het antwoord.

Voorbeeld van HTTP 401 (JSON)
{
  "success": false,
  "error": "Invalid or inactive API key."
}
200
Verzoek geslaagd
400
Ongeldige parameters
401
API-sleutel ontbreekt of is ongeldig
403
Geen toegang tot dit onderdeel
404
Niet gevonden
405
HTTP-methode niet ondersteund
500
Er is een serverfout opgetreden

Lijstverzoeken beginnen bij pagina 1 en geven standaard 20 resultaten per pagina, met een maximum van 100. Gebruik data.pagination.total_pages om te bepalen of er een volgende pagina is. Bij nul resultaten is total_pages 0.