Sunucu API'si | Noxyr Dokümantasyonu

API neleri sunar

API salt okunurdur ve tek bir sunucuyla sınırlıdır. Giriş yapmadan kontrol panelinin gösterdiği sayıları isteyen durum sayfaları, elektronik tablolar ve dahili araçlar için tasarlanmıştır. Ayarları değiştiremez, destek taleplerini kapatamaz veya fatura oluşturamaz.

Her uç nokta https://noxyrbot.com/api/v1 altındadır ve JSON döndürür. Anahtar sunucuyu tanımlar; bu yüzden hiçbir uç nokta sunucu ID'si istemez.

GET /api/v1/: Bu anahtar için hangi kapsamların açık olduğu ve ulaşabileceği uç noktalar.
GET /api/v1/server: Ad, simge, üye sayısı, çevrimiçi sayısı, boost'lar ve oluşturulma tarihi.
GET /api/v1/tickets: Toplamlar, açık ve kapalı sayıları, 7 ve 30 günlük hacim, ortalama puan.
GET /api/v1/activity?days=30: Günlük mesajlar, katılımlar ve ayrılmalar, 90 güne kadar.
GET /api/v1/invoices: Fatura sayıları, para birimine göre gelir ve ödeme durumu. invoice links kapsamıyla birlikte ?limit= indirilebilir bir resim URL'si olan son faturaları ekler.
GET /api/v1/reviews: Ortalama puan, yıldız dağılımı ve en son beş herkese açık değerlendirme.
GET /api/v1/giveaways: Aktif ve sona ermiş sayıları, toplam katılım ve mevcut çekilişler.

Anahtar oluşturma

Her sunucunun bir anahtarı vardır. Sunucunun API sayfasında oluşturulur ve yalnızca bir kez gösterilir - yalnızca bir özeti saklanır; bu yüzden kaybedilen bir anahtar yeniden oluşturulmalıdır, bu da eskisini geçersiz kılar.

Sunucuyu kontrol panelinde açın ve API'ye gidin.
Oluştur'a basın ve nxr_ ile başlayan anahtarı kopyalayın. Bir daha gösterilmez.
İhtiyacınız olmayan kapsamları kapatın. Fatura bağlantıları varsayılan olarak kapalıdır, çünkü müşteri fatura resimlerini açığa çıkarır.
İsteğe bağlı: botun sunucuda uç nokta listesiyle bir API kategorisi ve kanalı oluşturması için Kanal kur'a basın.

Sayfa ayrıca anahtarın en son ne zaman kullanıldığını ve kaç istek yaptığını da gösterir; sızmış bir anahtarı fark etmenin en hızlı yolu budur. Anahtarı anahtarla devre dışı bırakın ya da tamamen silmek için iptal edin.

Kapsamlar

Kapsamlar alanları değil, uç noktaları denetler. Kapsamı kapalı bir uç noktaya yapılan istek, kapsamın adını belirten bir mesajla 403 alır.

overview: /server
tickets: /tickets
activity: /activity
invoices: /invoices
invoiceLinks: Resim bağlantılarıyla son fatura listesini ekler. Varsayılan olarak kapalıdır.
reviews: /reviews
giveaways: /giveaways

Kimlik doğrulama ve örnek istek

Anahtarı Authorization başlığında Bearer token olarak gönderin. Tarayıcıdan çağrılara izin verilir (CORS açıktır), ancak ön yüz kodundaki bir anahtar herkese açık bir anahtardır; bu yüzden API'yi kendi kontrol ettiğiniz bir sunucudan çağırın.

curl -H "Authorization: Bearer nxr_your_key" https://noxyrbot.com/api/v1/tickets
Yanıt: {"total":128,"open":4,"closed":124,"opened7d":9,"opened30d":41,"closed7d":8,"averageRating":4.6,"ratingsCount":37}

Hız sınırları

Her anahtar dakikada 60 istek yapabilir. Limit, her yanıtta standart RateLimit başlıklarıyla döndürülür ve aşıldığında HTTP 429 ile "rate_limited" hatası döner. Veriler değişenden daha sık sorgulamayın - destek talebi ve satış toplamlarını dakikada bir okumak uygundur.

Hatalar

Her hata, makine tarafından okunabilir bir hata kodu ve insanlar için bir mesajla birlikte JSON'dur.

401 yetkisiz: Authorization başlığı eksik, Bearer token değil ya da anahtar mevcut değil.
403 key_disabled: Anahtar kontrol panelinde kapatıldı.
403 scope_disabled: Bu anahtar için bu kapsam kapalı.
404 not_found: Bilinmeyen uç nokta. Mesaj geçerli olanları listeler.
404 guild_unavailable: Bot artık sunucuda değil.
429 rate_limited: Bir dakikada 60'tan fazla istek.
500 internal_error: Noxyr tarafında bir şey başarısız oldu. Daha sonra tekrar deneyin.