Zum Hauptinhalt springen

Ocean API

Ocean bietet eine RESTful API für den programmatischen Zugriff auf Scan-Daten, Nutzerinformationen, Risikowerte und Erkennungssysteme. Alle Endpunkte verwenden API-Schlüssel zur Authentifizierung und sind auf 1.000 Anfragen pro Stunde begrenzt.

Voraussetzungen

Die Ocean API ist nur für Nutzer mit einer aktiven Lizenz oder Enterprise-Mitgliedschaftverfügbar. Kostenlose Nutzer können keine API-Schlüssel erstellen oder verwenden.

Die einzige Ausnahme ist /v1/versiondie öffentlich ist und keinen API-Schlüssel benötigt.

Basis-URL
https://api.anticheat.ac/v1
Authentifizierung
Übergib deinen API-Schlüssel über den Header x-api-key
Optional
Sende x-server-name um zu kennzeichnen, welcher deiner Server den Aufruf gemacht hat

Nutzungsprotokollierung

Jeder authentifizierte API-Aufruf wird aufgezeichnet: welcher Schlüssel verwendet wurde, welchen Endpunkt er aufgerufen hat, die IP des Aufrufers und der optionale x-server-name -Header. Die Protokolle werden 90 Tage aufbewahrt und dienen dazu, Schlüsselweitergabe und Missbrauch zu erkennen. Sie enthalten nie den vollständigen API-Schlüssel, nur seine ersten 12 Zeichen.

Wenn ein Schlüssel mehrere Server bedient, sende von jedem einen eigenen x-server-name Das ist der schnellste Weg, um zu zeigen, welcher Server einen bestimmten Aufruf gemacht hat.

Rate-Limiting

Alle API-Endpunkte teilen sich ein globales Rate-Limit von 1.000 Anfragen pro Stunde pro API-Schlüssel. Rate-Limit-Header (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) sind in jeder Antwort enthalten.