SONKALE / DOCS

Başlangıç ve API

Tarama akışını mevcut moderasyon araçlarınıza bağlayın.

İlk tarama

Yönetici bir plan oluşturur, kullanıcıya lisans atar. Kullanıcı panelde Yeni Tarama ile PIN üretir. Oyuncu Scanner’da kodu girer ve kapsamı onaylar. Sonuç canlı rapora gelir.

API kimlik doğrulama

/api/v1/ altında REST endpoint’leri kullanılır. Authorization: Bearer sk_live_… başlığını gönderin. Anahtar hash olarak saklanır; yalnızca oluşturulurken gösterilir.

İstek tekrarları

POST /api/v1/scans için Idempotency-Key başlığı zorunludur. Aynı anahtar ve aynı veri aynı taramayı döndürür; farklı veri 409 döndürür.

Yetkiler

scan:read, scan:create, scan:review, rules:read ve analytics:read kapsamları desteklenir. Kota ve ekip yetkileri API üzerinden de uygulanır.

FiveM

Sunucu kaynak paketini fivem/sonkale_scanner dizininden kurun. Sunucu tarafı API anahtarıyla /scanplayer komutu PIN oluşturur. Oyuncunun bilgisayarını gizlice taramaz.

İlerleme ve hata kodları

GET /api/v1/scans/{id}/events SSE üretir. PIN_EXPIRED: süre doldu; PIN_USED: kullanılmış; QUOTA_EXHAUSTED: hak bitti; UPDATE_REQUIRED: sürüm güncellemesi gerekli.

Kontrol paneli ↗Scanner’ı indir