Introdução à REST API
O SportsPress 2.0 introduziu endpoints para a WP REST API, permitindo acesso programático para gerenciar dados do site. O plugin requer o plugin WP REST API (versão 2) para funcionalidade básica. O WordPress 4.7 e posterior inclui a REST API nativamente — nenhum plugin adicional é necessário em instalações modernas do WordPress.
Requisições GET (leitura de dados) não requerem autenticação. Requisições POST, PUT e DELETE (criação, atualização ou exclusão de dados) requerem autenticação.
URL Base
Todos os endpoints da REST API do SportsPress estão disponíveis em:
/wp-json/sportspress/v2/
Substitua example.com pelo domínio do seu site:
https://example.com/wp-json/sportspress/v2/events
Endpoints Disponíveis
Recurso | Endpoint |
Eventos |
|
Times |
|
Jogadores |
|
Equipe |
|
Calendários |
|
Tabelas de Liga |
|
Listas de Jogadores |
|
Cada endpoint suporta as convenções padrão da REST API do WordPress: listar todos os recursos com GET, recuperar um único recurso com GET /{id}, criar com POST, atualizar com PUT ou PATCH, e excluir com DELETE.
Métodos HTTP
Método | Ação |
| Recuperar um ou mais recursos |
| Criar um novo recurso |
| Atualizar um recurso existente |
| Excluir um recurso |
Autenticação
A autenticação é necessária para todas as operações de escrita. Consulte o artigo de Autenticação para instruções de configuração usando Senhas de Aplicativo e Postman.
Limitações Conhecidas
Jogadores criados via REST API podem não aparecer automaticamente nas listas de jogadores. Após criar um jogador via API, atribua manualmente o jogador ao time relevante no admin, ou certifique-se de que a lista de jogadores está configurada para incluir esse time.
Eventos agendados (futuros) requerem o valor de status
futureao criar via API.O parâmetro de consulta
_fieldsé suportado para filtrar campos de resposta (disponível no SportsPress Pro 2.7.16 e posterior após uma correção de erro de API com_fields).