Listar cursos

Descrição

Endpoint para listar cursos ativos disponíveis para matrícula.

📋 Detalhes da Requisição

URL

GET https://seudominio.com/api/courses

Headers Obrigatórios

Query Parameters (Opcionais)

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
`page`	int	❌ Não	Número da página (padrão: 1)	`?page=2`
`limit`	int	❌ Não	Registros por página (padrão: 100, máx: 200)	`?limit=50`

📤 Respostas da API

✅ Sucesso (200 OK)

{
  "success": true,
  "message": "Cursos recuperados com sucesso",
  "data": {
    "courses": [
      {
        "id": 789,
        "valor": 299.90,
        "promocao": 199.90,
        "titulo": "Curso de Programação em PHP"
      },
      {
        "id": 101112,
        "valor": 399.90,
        "promocao": null,
        "titulo": "Curso de JavaScript Avançado"
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 100,
      "total_records": 45,
      "total_pages": 1,
      "has_next_page": false,
      "has_previous_page": false
    }
  },
  "timestamp": "2025-01-28 10:30:00",
  "status_code": 200
}

✅ Sucesso - Lista Vazia (200 OK)

{
  "success": true,
  "message": "Cursos recuperados com sucesso",
  "data": {
    "courses": [],
    "pagination": {
      "current_page": 1,
      "per_page": 100,
      "total_records": 0,
      "total_pages": 0,
      "has_next_page": false,
      "has_previous_page": false
    }
  },
  "timestamp": "2025-01-28 10:30:00",
  "status_code": 200
}

❌ Erro - Token Inválido (401 Unauthorized)

{
  "success": false,
  "message": "Unauthorized - Invalid or missing token",
  "errors": [],
  "timestamp": "2025-01-28 10:30:00",
  "status_code": 401
}

🔍 Campos Retornados

Dados do Curso

Campo	Tipo	Descrição	Exemplo
`id`	int	ID único do curso (código identificador)	`789`
`valor`	float	Valor do curso em reais	`299.90`
`promocao`	float	Valor promocional (null se não houver)	`199.90` ou `null`
`titulo`	string	Título/nome do curso	`"Curso de PHP"`

Informações de Paginação

Campo	Tipo	Descrição
`current_page`	int	Página atual
`per_page`	int	Registros por página
`total_records`	int	Total de registros encontrados
`total_pages`	int	Total de páginas
`has_next_page`	bool	Indica se há próxima página
`has_previous_page`	bool	Indica se há página anterior

⚠️ Códigos de Status HTTP

Código	Descrição	Quando Ocorre
`200`	OK	Cursos recuperados com sucesso
`401`	Unauthorized	Token inválido ou não fornecido
`500`	Internal Server Error	Erro interno do servidor

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

application/json

Body

Exemplo

{
    "success": true,
    "message": "string",
    "data": {
        "courses": [
            {
                "id": 0,
                "valor": 0,
                "promocao": 0,
                "titulo": "string"
            }
        ],
        "pagination": {
            "current_page": 0,
            "per_page": 0,
            "total_records": 0,
            "total_pages": 0,
            "has_next_page": true,
            "has_previous_page": true
        }
    },
    "timestamp": "string",
    "status_code": 0
}

Descrição#

📋 Detalhes da Requisição#

URL#

Headers Obrigatórios#

Query Parameters (Opcionais)#

📤 Respostas da API#

✅ Sucesso (200 OK)#

✅ Sucesso - Lista Vazia (200 OK)#

❌ Erro - Token Inválido (401 Unauthorized)#

🔍 Campos Retornados#

Dados do Curso#

Informações de Paginação#

⚠️ Códigos de Status HTTP#

Requisição

Exemplos de Requisição

Respostas