API-Dokumentation

Cordavix stellt eine REST-API (v1) bereit, über die das Dashboard selbst sowie eigene Integrationen mit deinem Konto und deinen Servern kommunizieren können.

Wo die vollständige Referenz liegt

Die vollständige, technische API-Referenz pflegen wir im Repository unter docs/api.md. Dort findest du alle Endpunkte, Anfrage-/Antwortformate und Fehlercodes im Detail.

Grundlagen

• Basis-URL: die jeweilige Cordavix-API-Instanz (z. B.

https://api.deine-cordavix-instanz.example).

• Antwortformat: alle Antworten folgen demselben Umschlag –

{ "success": true, "data": … } bei Erfolg bzw. { "success": false, "error": { "code", "message", "details?" } } bei einem Fehler.

• Authentifizierung: ein signiertes, HttpOnly-Session-Cookie – für

eigene Skripte außerhalb des Browsers ist die API aktuell nicht als offizielles Entwickler-Produkt mit eigenen API-Schlüsseln gedacht.

• Rate Limit: 120 Anfragen pro Minute und IP-Adresse; einzelne

sensible Endpunkte (z. B. Anmeldung, Kontakt) sind zusätzlich enger begrenzt.

Wichtige öffentliche Endpunkte

Diese Endpunkte sind ohne Anmeldung erreichbar und liegen dieser Website zugrunde:

| Endpunkt | Zweck | | --- | --- | | GET /api/v1/billing/plans | Öffentliche Preisliste | | GET /api/v1/public/faq | Häufige Fragen | | GET /api/v1/public/giveaways | Öffentliche Gewinnspielübersicht | | GET /api/v1/public/giveaways/:slug | Gewinnspiel-Detail | | GET /api/v1/public/legal/:type | Rechtsdokumente (Impressum, AGB, …) | | GET /api/v1/public/status | Systemstatus | | POST /api/v1/contact | Kontaktformular | | POST /api/v1/newsletter | Newsletter-Anmeldung |

Angemeldete Endpunkte (Auszug)

Für dein eigenes Konto und deine Server stehen unter anderem folgende Bereiche zur Verfügung (vollständige Liste in docs/api.md): Benutzerprofil, Serververwaltung, Moderation, Module, Tickets, Level-System, Economy, Abrechnung, eigene Bots, Organisationen sowie Datenexport und Kontolöschung.

Fehlercodes

Neben allgemeinen Fehlercodes wie VALIDATION_ERROR, UNAUTHORIZED oder RATE_LIMITED verwenden einzelne Bereiche eigene, sprechende Codes (z. B. GIVEAWAY_NOT_ACTIVE, EMAIL_NOT_VERIFIED, BILLING_NOT_CONFIGURED) – auch diese sind vollständig in docs/api.md dokumentiert.

Hinweis

Diese API ist in erster Linie die Grundlage für unser eigenes Dashboard. Planst du eine eigene Integration, empfehlen wir, uns vorher über das Kontaktformular (Kategorie „Technisches Problem“) zu kontaktieren.