Courses

Obtém todos os cursos da plataforma

get

Este endpoint retorna todos os cursos cadastrados na plataforma, independentemente do status. Caso não haja nenhum curso cadastrado, será retornada uma lista vazia.

Authorizations

HTTPRequired

Responses

200

The request has succeeded.

application/json

401

Access is unauthorized.

application/json

429

Client error

application/json

500

Server error

application/json

get/courses

GET /api/v1/courses HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "status": "text",
      "slug": "text",
      "blocked": 1,
      "published": 1,
      "url_upsell": "text",
      "text_upsell": "text",
      "modules": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "slug": "text",
          "blocked": "text",
          "published": "text",
          "url_upsell": "text",
          "text_upsell": "text",
          "lessons": [
            {
              "id": "text",
              "title": "text",
              "subtitle": "text",
              "slug": "text",
              "blocked": "text",
              "published": "text",
              "url_upsell": "text",
              "text_upsell": "text"
            }
          ]
        }
      ]
    }
  ],
  "links": {
    "first": "text",
    "last": "text",
    "prev": "text",
    "next": "text"
  },
  "meta": {
    "first": "text",
    "last": "text",
    "prev": "text",
    "next": "text"
  }
}

Obtém um curso por ID

get

Este endpoint retorna um curso por ID cadastrado na plataforma, independentemente do status.

Caso o curso não seja encontrado, uma exception CourseNotFoundException será lançada.

Authorizations

HTTPRequired

Path parameters

course_idstringRequired

Responses

200

The request has succeeded.

application/json

401

Access is unauthorized.

application/json

404

The server cannot find the requested resource.

application/json

429

Client error

application/json

500

Server error

application/json

get/courses/{course_id}

GET /api/v1/courses/{course_id} HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": "text",
    "title": "text",
    "description": "text",
    "status": "text",
    "slug": "text",
    "blocked": 1,
    "published": 1,
    "url_upsell": "text",
    "text_upsell": "text",
    "modules": [
      {
        "id": "text",
        "title": "text",
        "description": "text",
        "slug": "text",
        "blocked": "text",
        "published": "text",
        "url_upsell": "text",
        "text_upsell": "text",
        "lessons": [
          {
            "id": "text",
            "title": "text",
            "subtitle": "text",
            "slug": "text",
            "blocked": "text",
            "published": "text",
            "url_upsell": "text",
            "text_upsell": "text"
          }
        ]
      }
    ]
  }
}

Obtém historico de acesso a um curso

get

Este endpoint retorna uma lista com o histórico de acesso de cada aluno em um curso específico. Com essas informações, é possível identificar se o aluno já concluiu o curso e em qual data ocorreu a conclusão, além de verificar o último acesso realizado nesse curso.

Caso o course_id informado não seja encontrado, será lançada a exception CourseNotFoundException.

Authorizations

HTTPRequired

Path parameters

course_idstringRequired

Responses

200

The request has succeeded.

application/json

401

Access is unauthorized.

application/json

404

The server cannot find the requested resource.

application/json

429

Client error

application/json

500

Server error

application/json

get/courses/{course_id}/accesses

GET /api/v1/courses/{course_id}/accesses HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "email": "text",
      "course": {
        "id": "text",
        "name": "text",
        "last_access_at": "text",
        "finished": 1,
        "finished_at": "text"
      }
    }
  ]
}