Documentação API

Integre o SquadHub.GG em suas aplicações com nossa API REST

Primeiros Passos

1. Obtenha uma Chave de API

O acesso à API está disponível para usuários do plano Organização. Crie uma chave de API nas configurações da conta.

2. Autenticação

Inclua sua chave de API no cabeçalho Authorization de cada requisição:

Authorization: Bearer sk_live_your_api_key_here

3. URL Base

https://squadhub.gg/api/v1

4. Limites de Requisição

100 requisições por minuto por chave de API

Endpoints da API

GET

/api/v1/tournaments

Listar todos os seus torneios

read:tournaments

Parâmetros de Consulta

page(number)Número da página (padrão: 1)

limit(number)Resultados por página (padrão: 20, máx: 100)

status(string)Filtrar por status (registration, ongoing, completed)

game_id(string)Filtrar por ID do jogo

Resposta

{
  "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

Criar um novo torneio

write:tournaments

Corpo da Requisição

{
  "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"
}

Resposta

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

GET

/api/v1/tournaments/{id}

Obter detalhes do torneio

read:tournaments

Resposta

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

PATCH

/api/v1/tournaments/{id}

Atualizar torneio

write:tournaments

Corpo da Requisição

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

Resposta

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

DELETE

/api/v1/tournaments/{id}

Excluir torneio

write:tournaments

Resposta

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

GET

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

Listar inscrições do torneio

read:registrations

Parâmetros de Consulta

status(string)Filtrar por status de pagamento

Resposta

{
  "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

Inscrever um time no torneio

write:registrations

Corpo da Requisição

{
  "team_id": "uuid"
}

Resposta

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

GET

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

Obter resultados e classificações do torneio

read:results

Resposta

{
  "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": { ... }
}

Códigos de Erro

400

Requisição Inválida

Parâmetros ou corpo da requisição inválidos

401

Não Autorizado

Chave de API ausente ou inválida

403

Proibido

Permissão necessária ausente

404

Não Encontrado

Recurso não encontrado

429

Muitas Requisições

Limite de requisições excedido

500

Erro do Servidor

Ocorreu um erro no servidor

{ "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": { ... } }