Przejdź do głównej treści

API Ocean

Ocean udostępnia RESTowe API do programowego dostępu do danych skanowania, informacji o użytkownikach, wyników ryzyka i systemów wykrywania. Wszystkie endpointy używają kluczy API do uwierzytelniania i mają limit 1000 żądań na godzinę.

Wymagania

Ocean API jest dostępne tylko dla użytkowników z aktywną licencją lub członkostwem w Enterprise. Darmowi użytkownicy nie mogą tworzyć ani używać kluczy API.

Jedynym wyjątkiem jest /v1/version, który jest publiczny i nie wymaga klucza API.

Bazowy URL
https://api.anticheat.ac/v1
Uwierzytelnianie
Przekaż klucz API w nagłówku x-api-key
Opcjonalnie
Wyślij x-server-name aby oznaczyć, który z Twoich serwerów wykonał wywołanie

Logowanie użycia

Każde uwierzytelnione wywołanie API jest rejestrowane: użyty klucz, trafiony endpoint, adres IP wywołującego oraz opcjonalny nagłówek x-server-name . Logi są przechowywane przez 90 dni i służą do wykrywania współdzielenia kluczy i nadużyć. Nigdy nie zawierają pełnego klucza API, tylko jego pierwsze 12 znaków.

Jeśli jeden klucz obsługuje kilka serwerów, wysyłaj inny nagłówek x-server-name z każdego z nich. To najszybszy sposób, by pokazać, który serwer wykonał dane wywołanie.

Limity żądań

Wszystkie endpointy API mają wspólny globalny limit 1000 żądań na godzinę na klucz API. Nagłówki limitów (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) są dołączane do każdej odpowiedzi.