🔑Acessos

🔎 Listar acessos

Endpoint

GET https://sua-plataforma.ensinio.cloud/public/api/v1/accesses

Headers obrigatórios

Authorization: Bearer {token}
X-Requested-With: XMLHttpRequest

(Os mesmos do “Getting Started”.)

Descrição

Retorna a lista de acessos (compras únicas e assinaturas) da plataforma, com paginação e filtro por recorrência.

Este endpoint depende da feature estar habilitada no seu plano.

Parâmetros de query

Parâmetro	Tipo	Obrigatório	Padrão	Descrição
`recurrent`	boolean	❌	—	Filtra por recorrência do acesso. `true` para assinaturas (`recurrent`), `false` para compras únicas (`unique`)
`page`	integer	❌	`1`	Número da página.
`per_page`	integer	❌	`15`	Quantidade de itens por página.

Exemplos de requisição

Listar todos os acessos (sem filtro)

GET /public/api/v1/accesses?page=1&per_page=15

Apenas assinaturas (recorrentes)

GET /public/api/v1/accesses?recurrent=true&page=1&per_page=15

Apenas compras únicas

GET /public/api/v1/accesses?recurrent=false&page=2&per_page=50

Exemplo de resposta

{
  "data": [
    {
      "id": "acc_01J8Z5V3S9",
      "amount": 197.00,
      "payment_type": "recurrent",
      "product": "Curso Completo de Marketing",
      "username": "Maria Oliveira",
      "payment_method": "credit_card",
      "status": "paid",
      "situation": "active",
      "validity": "2026-05-12T14:20:31Z"
    },
    {
      "id": "acc_01J8Z6K7LM",
      "amount": 49.90,
      "payment_type": "unique",
      "product": "E-book Vendas",
      "username": "João Silva",
      "payment_method": "pix",
      "status": "unpaid",
      "situation": "inactive",
      "validity": null
    }
  ],
  "links": {
    "first": "https://sua-plataforma.ensinio.cloud/public/api/v1/accesses?page=1",
    "last": "https://sua-plataforma.ensinio.cloud/public/api/v1/accesses?page=10",
    "prev": null,
    "next": "https://sua-plataforma.ensinio.cloud/public/api/v1/accesses?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "path": "https://sua-plataforma.ensinio.cloud/public/api/v1/accesses",
    "per_page": 15,
    "to": 15,
    "total": 150
  }
}

🧩 Estrutura de cada item

Campo	Tipo	Descrição
`id`	string	Identificador único do acesso.
`amount`	number	Valor total pago na transação.
`payment_type`	string	Tipo de pagamento (`unique` ou `recurrent`).
`product`	string	Nome do grupo ou curso associado ao acesso.
`username`	string	Nome do usuário que possui o acesso.
`payment_method`	string	Método de pagamento utilizado (ex: `credit_card`, `pix`, `boleto`).
`status`	string	Status interno do acesso (ex: `paid`, `unpaid`, `pending`).
`situation`	string	Situação atual do acesso (ex: `active`, `inactive`).
`validity`	string	Data de validade do acesso, ou `null` se vitalício.

Possíveis respostas

200 OK

Retorna a lista paginada conforme o exemplo acima.

400 Bad Request

{
  "message": "Parâmetro 'per_page' inválido."
}

401 Unauthorized

{
  "message": "Token inválido ou ausente."
}

500 Internal Server Error

{
  "message": "Ocorreu um erro ao listar os acessos."
}

💡 Dicas

Para filtrar acessos recorrentes, use ?recurrent=true ou ?recurrent=1.
Para compras únicas, use ?recurrent=false ou ?recurrent=0.
Use page e per_page para controlar a paginação dos resultados.