API Dokümantasyonu

REST API'miz ile SquadHub.GG'yi uygulamalarınıza entegre edin

Başlarken

1. API Anahtarı Alın

API erişimi Organizasyon planı kullanıcıları için mevcuttur. API anahtarınızı hesap ayarlarınızda.

2. Kimlik Doğrulama

API anahtarınızı her isteğin Authorization başlığına ekleyin:

Authorization: Bearer sk_live_your_api_key_here

3. Temel URL

https://squadhub.gg/api/v1

4. İstek Limitleri

API anahtarı başına dakikada 100 istek

API Uç Noktaları

GET

/api/v1/tournaments

Tüm turnuvalarınızı listeleyin

read:tournaments

Sorgu Parametreleri

page(number)Sayfa numarası (varsayılan: 1)

limit(number)Sayfa başına sonuç (varsayılan: 20, maks: 100)

status(string)Duruma göre filtrele (registration, ongoing, completed)

game_id(string)Oyun ID'sine göre filtrele

Yanıt

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "name": "Tournament Name",
      "slug": "tournament-slug",
      "status": "registration",
      "format": "single_elimination",
      "team_size": 5,
      "max_teams": 32,
      ...
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45
  },
  "meta": {
    "timestamp": "2025-12-11T...",
    "api_version": "1.0"
  }
}

POST

/api/v1/tournaments

Yeni turnuva oluşturun

write:tournaments

İstek Gövdesi

{
  "name": "Summer Championship 2025",
  "description": "Annual summer tournament",
  "game_id": "uuid",
  "format": "single_elimination",
  "team_size": 5,
  "max_teams": 32,
  "entry_fee": 0,
  "prize_pool": 1000,
  "starts_at": "2025-07-01T18:00:00Z",
  "registration_closes": "2025-06-25T18:00:00Z",
  "rules": "Standard tournament rules apply"
}

Yanıt

{
  "success": true,
  "data": {
    "id": "uuid",
    "name": "Summer Championship 2025",
    "slug": "summer-championship-2025-abc123",
    "status": "registration",
    ...
  },
  "meta": { ... }
}

GET

/api/v1/tournaments/{id}

Turnuva detaylarını alın

read:tournaments

Yanıt

{
  "success": true,
  "data": {
    "id": "uuid",
    "name": "Tournament Name",
    ...
  },
  "meta": { ... }
}

PATCH

/api/v1/tournaments/{id}

Turnuvayı güncelleyin

write:tournaments

İstek Gövdesi

{
  "name": "Updated Name",
  "max_teams": 64,
  "status": "ongoing"
}

Yanıt

{
  "success": true,
  "data": { ... },
  "meta": { ... }
}

DELETE

/api/v1/tournaments/{id}

Turnuvayı silin

write:tournaments

Yanıt

{
  "success": true,
  "data": {
    "message": "Tournament deleted successfully"
  },
  "meta": { ... }
}

GET

/api/v1/tournaments/{id}/registrations

Turnuva kayıtlarını listeleyin

read:registrations

Sorgu Parametreleri

status(string)Ödeme durumuna göre filtrele

Yanıt

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "tournament_id": "uuid",
      "team_id": "uuid",
      "payment_status": "complete",
      "registered_at": "2025-06-20T...",
      "teams": {
        "id": "uuid",
        "name": "Team Name",
        "tag": "TAG",
        "logo_url": "..."
      }
    }
  ],
  "meta": { ... }
}

POST

/api/v1/tournaments/{id}/registrations

Turnuvaya takım kaydedin

write:registrations

İstek Gövdesi

{
  "team_id": "uuid"
}

Yanıt

{
  "success": true,
  "data": {
    "id": "uuid",
    "tournament_id": "uuid",
    "team_id": "uuid",
    ...
  },
  "meta": { ... }
}

GET

/api/v1/tournaments/{id}/results

Turnuva sonuçlarını ve sıralamayı alın

read:results

Yanıt

{
  "success": true,
  "data": {
    "tournament": {
      "id": "uuid",
      "format": "single_elimination",
      "status": "completed"
    },
    "matches": [ ... ],
    "standings": [
      {
        "position": 1,
        "team_id": "uuid",
        "team_name": "Champions",
        "team_tag": "CHM"
      }
    ]
  },
  "meta": { ... }
}

Hata Kodları

400

Geçersiz İstek

Geçersiz istek parametreleri veya gövdesi

401

Yetkisiz

Eksik veya geçersiz API anahtarı

403

Yasak

Gerekli izin eksik

404

Bulunamadı

Kaynak bulunamadı

429

Çok Fazla İstek

İstek limiti aşıldı

500

Sunucu Hatası

Bir sunucu hatası oluştu

{ "success": true, "data": [ { "id": "uuid", "name": "Tournament Name", "slug": "tournament-slug", "status": "registration", "format": "single_elimination", "team_size": 5, "max_teams": 32, ... } ], "pagination": { "page": 1, "limit": 20, "total": 45 }, "meta": { "timestamp": "2025-12-11T...", "api_version": "1.0" } }

{ "name": "Summer Championship 2025", "description": "Annual summer tournament", "game_id": "uuid", "format": "single_elimination", "team_size": 5, "max_teams": 32, "entry_fee": 0, "prize_pool": 1000, "starts_at": "2025-07-01T18:00:00Z", "registration_closes": "2025-06-25T18:00:00Z", "rules": "Standard tournament rules apply" }

{ "success": true, "data": { "id": "uuid", "name": "Summer Championship 2025", "slug": "summer-championship-2025-abc123", "status": "registration", ... }, "meta": { ... } }

{ "success": true, "data": [ { "id": "uuid", "tournament_id": "uuid", "team_id": "uuid", "payment_status": "complete", "registered_at": "2025-06-20T...", "teams": { "id": "uuid", "name": "Team Name", "tag": "TAG", "logo_url": "..." } } ], "meta": { ... } }

{ "success": true, "data": { "tournament": { "id": "uuid", "format": "single_elimination", "status": "completed" }, "matches": [ ... ], "standings": [ { "position": 1, "team_id": "uuid", "team_name": "Champions", "team_tag": "CHM" } ] }, "meta": { ... } }