Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Students

Obtém todos os alunos

get

Este endpoint retorna todos os alunos cadastrados na plataforma, independentemente de possuírem uma assinatura ativa ou não. Por padrão, as assinaturas não são carregadas. Para incluí-las na resposta, utilize o parâmetro with=subscriptions na query string, permitindo o carregamento das assinaturas de cada aluno.

Authorizations
HTTPRequired
Query parameters
withstringOptional

Permite incluir as assinaturas. Ex: with=subscriptions. Caso não seja informado, as assinaturas não serão carregadas.

Responses
200

The request has succeeded.

application/json
get/students
GET /api/v1/students HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "first_name": "text",
      "last_name": "text",
      "full_name": "text",
      "email": "text",
      "photo_url": "text",
      "phone": "text",
      "genre": "text",
      "birth": "text",
      "document": "text",
      "reference_id": "text",
      "created_at": "text",
      "updated_at": "text",
      "subscriptions": [
        {
          "active": 1,
          "status": "active",
          "product_id": "text",
          "payment_last_date": "text",
          "accession_date": "text",
          "expiration_date": "text",
          "cancel_date": "text",
          "product": {
            "id": "text",
            "title": "text",
            "description": "text",
            "created_at": "text",
            "updated_at": "text"
          },
          "created_at": "text",
          "updated_at": "text"
        }
      ]
    }
  ],
  "links": {
    "first": "text",
    "last": "text",
    "prev": "text",
    "next": "text"
  },
  "meta": {
    "first": "text",
    "last": "text",
    "prev": "text",
    "next": "text"
  }
}

Criar novo aluno

post

Este endpoint realiza apenas o cadastro do aluno, não criando nenhuma assinatura. A assinatura deve ser criada posteriormente, por meio do endpoint específico de criação de assinaturas, utilizando o ID do aluno previamente cadastrado.

Caso seja informado um e-mail já existente, será lançado uma exception StudentAlreadyExistsException.

Authorizations
HTTPRequired
Body
idstringRead-onlyRequired

ID do aluno

first_namestringRequired

Nome

last_namestring · nullableOptional

Sobrenome

full_namestringRead-onlyRequired

Nome completo

emailstringRequired

E-mail

photo_urlstring · nullableRead-onlyOptional

URL da foto

phonestring · nullableOptional

Telefone

genrestring · nullableRead-onlyOptional

Gênero

birthstring · nullableOptional

Data de nascimento

documentstring · nullableOptional

Documento do aluno

reference_idstring · nullableOptional

Identificador externo do aluno (Usado para integrações externas)

created_atstringRead-onlyRequired

Data de criação

updated_atstringRead-onlyRequired

Data da última atualização

Responses
201

The request has succeeded and a new resource has been created as a result.

application/json
post/students
POST /api/v1/students HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "first_name": "text",
  "last_name": "text",
  "email": "text",
  "phone": "text",
  "birth": "text",
  "document": "text",
  "reference_id": "text"
}
{
  "data": {
    "id": "text",
    "first_name": "text",
    "last_name": "text",
    "full_name": "text",
    "email": "text",
    "photo_url": "text",
    "phone": "text",
    "genre": "text",
    "birth": "text",
    "document": "text",
    "reference_id": "text",
    "created_at": "text",
    "updated_at": "text"
  }
}

Obtem aluno por document

get

Este endpoint retorna um aluno pelo seu document, desde que esteja cadastrado na plataforma, independentemente de possuir ou não uma assinatura ativa.

Caso o aluno não seja encontrado, será lançada a exceção StudentNotFoundException.

Authorizations
HTTPRequired
Path parameters
documentstringRequired
Responses
200

The request has succeeded.

application/json
get/students/document/{document}
GET /api/v1/students/document/{document} HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": "text",
    "first_name": "text",
    "last_name": "text",
    "full_name": "text",
    "email": "text",
    "photo_url": "text",
    "phone": "text",
    "genre": "text",
    "birth": "text",
    "document": "text",
    "reference_id": "text",
    "created_at": "text",
    "updated_at": "text",
    "subscriptions": [
      {
        "active": 1,
        "status": "active",
        "product_id": "text",
        "payment_last_date": "text",
        "accession_date": "text",
        "expiration_date": "text",
        "cancel_date": "text",
        "product": {
          "id": "text",
          "title": "text",
          "description": "text",
          "created_at": "text",
          "updated_at": "text"
        },
        "created_at": "text",
        "updated_at": "text"
      }
    ]
  }
}

Obtém aluno por e-mail

get

Este endpoint retorna um aluno com base em seu e-mail, desde que esteja cadastrado na plataforma, independentemente de possuir uma assinatura ativa ou não. Neste caso, as assinaturas são sempre carregadas na resposta.

Caso o aluno não seja encontrado, será lançada a exceção StudentNotFoundException.

Authorizations
HTTPRequired
Path parameters
emailstringRequired
Responses
200

The request has succeeded.

application/json
get/students/email/{email}
GET /api/v1/students/email/{email} HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": "text",
    "first_name": "text",
    "last_name": "text",
    "full_name": "text",
    "email": "text",
    "photo_url": "text",
    "phone": "text",
    "genre": "text",
    "birth": "text",
    "document": "text",
    "reference_id": "text",
    "created_at": "text",
    "updated_at": "text",
    "subscriptions": [
      {
        "active": 1,
        "status": "active",
        "product_id": "text",
        "payment_last_date": "text",
        "accession_date": "text",
        "expiration_date": "text",
        "cancel_date": "text",
        "product": {
          "id": "text",
          "title": "text",
          "description": "text",
          "created_at": "text",
          "updated_at": "text"
        },
        "created_at": "text",
        "updated_at": "text"
      }
    ]
  }
}

Criar link mágico por email

post

Este endpoint gera um link mágico utilizando o próprio e-mail do aluno.

Authorizations
HTTPRequired
Path parameters
emailstringRequired
Body
expire_inintegerRequired

Tempo de expiração em segundos

Default: 5
urlstringRead-onlyRequired

Link mágico para acesso à plataforma

Responses
200

The request has succeeded.

application/json
post/students/email/{email}/magic-link
POST /api/v1/students/email/{email}/magic-link HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "expire_in": 5
}
{
  "data": {
    "expire_in": 5,
    "url": "text"
  }
}

Obtem aluno por reference_id

get

Este endpoint retorna um aluno pelo seu reference_id, desde que esteja cadastrado na plataforma, independentemente de possuir ou não uma assinatura ativa.

Caso o aluno não seja encontrado, será lançada a exceção StudentNotFoundException.

Authorizations
HTTPRequired
Path parameters
reference_idstringRequired
Responses
200

The request has succeeded.

application/json
get/students/reference/{reference_id}
GET /api/v1/students/reference/{reference_id} HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": "text",
    "first_name": "text",
    "last_name": "text",
    "full_name": "text",
    "email": "text",
    "photo_url": "text",
    "phone": "text",
    "genre": "text",
    "birth": "text",
    "document": "text",
    "reference_id": "text",
    "created_at": "text",
    "updated_at": "text",
    "subscriptions": [
      {
        "active": 1,
        "status": "active",
        "product_id": "text",
        "payment_last_date": "text",
        "accession_date": "text",
        "expiration_date": "text",
        "cancel_date": "text",
        "product": {
          "id": "text",
          "title": "text",
          "description": "text",
          "created_at": "text",
          "updated_at": "text"
        },
        "created_at": "text",
        "updated_at": "text"
      }
    ]
  }
}

Obtém aluno por ID

get

Este endpoint retorna um aluno com base em seu ID, desde que esteja cadastrado na plataforma, independentemente de possuir uma assinatura ativa ou não. Neste caso, as assinaturas são sempre carregadas na resposta.

Caso o aluno não seja encontrado, será lançada a exceção StudentNotFoundException.

Authorizations
HTTPRequired
Path parameters
student_idstringRequired
Responses
200

The request has succeeded.

application/json
get/students/{student_id}
GET /api/v1/students/{student_id} HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": "text",
    "first_name": "text",
    "last_name": "text",
    "full_name": "text",
    "email": "text",
    "photo_url": "text",
    "phone": "text",
    "genre": "text",
    "birth": "text",
    "document": "text",
    "reference_id": "text",
    "created_at": "text",
    "updated_at": "text",
    "subscriptions": [
      {
        "active": 1,
        "status": "active",
        "product_id": "text",
        "payment_last_date": "text",
        "accession_date": "text",
        "expiration_date": "text",
        "cancel_date": "text",
        "product": {
          "id": "text",
          "title": "text",
          "description": "text",
          "created_at": "text",
          "updated_at": "text"
        },
        "created_at": "text",
        "updated_at": "text"
      }
    ]
  }
}

Excluir o cadastro de aluno

delete

Este endpoint realiza a exclusão de um aluno na plataforma. Caso o aluno possua assinaturas, elas também serão excluídas.

Caso o aluno não seja encontrado, será lançada a exceção StudentNotFoundException.

Authorizations
HTTPRequired
Path parameters
student_idstringRequired
Responses
204

There is no content to send for this request, but the headers may be useful.

No content
delete/students/{student_id}
DELETE /api/v1/students/{student_id} HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Criar link mágico por ID

post

Este endpoint gera um link mágico utilizando o próprio ID do aluno.

Authorizations
HTTPRequired
Path parameters
student_idstringRequired
Body
expire_inintegerRequired

Tempo de expiração em segundos

Default: 5
urlstringRead-onlyRequired

Link mágico para acesso à plataforma

Responses
200

The request has succeeded.

application/json
post/students/{student_id}/magic-link
POST /api/v1/students/{student_id}/magic-link HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "expire_in": 5
}
{
  "data": {
    "expire_in": 5,
    "url": "text"
  }
}

Obtém todos os produtos relacionados a um aluno (Assinaturas).

get

Este endpoint retorna todos os produtos (Assinataruas) relacionados a um aluno pelo seu ID.

Caso o aluno não possua nenhum produto (Assinatura), será retornada uma lista vazia.

Authorizations
HTTPRequired
Path parameters
student_idstringRequired
Responses
200

The request has succeeded.

application/json
get/students/{student_id}/products
GET /api/v1/students/{student_id}/products HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "active": 1,
      "status": "active",
      "product_id": "text",
      "payment_last_date": "text",
      "accession_date": "text",
      "expiration_date": "text",
      "cancel_date": "text",
      "product": {
        "id": "text",
        "title": "text",
        "description": "text",
        "created_at": "text",
        "updated_at": "text"
      },
      "created_at": "text",
      "updated_at": "text"
    }
  ]
}

Criar uma assinatura

post

Este endpoint cria uma assinatura para um aluno.

Caso seja informado um ID de aluno inexistente, será lançada a exceção StudentNotFoundException.

Caso seja informado um ID de produto inexistente, será lançada a exceção ProductNotFoundException.

Caso o aluno já possua essa assinatura, será lançada a exceção SubscriptionAlreadyExistsException.

Authorizations
HTTPRequired
Path parameters
student_idstringRequired
Body
product_idstringRequired

ID do produto

accession_datestringRequired

Data de adesão YYYY-MM-DD

expiration_datestringRequired

Data de expiração YYYY-MM-DD

Responses
201

The request has succeeded and a new resource has been created as a result.

application/json
post/students/{student_id}/products
POST /api/v1/students/{student_id}/products HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "product_id": "text",
  "accession_date": "text",
  "expiration_date": "text"
}
{
  "data": {
    "active": 1,
    "status": "active",
    "product_id": "text",
    "payment_last_date": "text",
    "accession_date": "text",
    "expiration_date": "text",
    "cancel_date": "text",
    "product": {
      "id": "text",
      "title": "text",
      "description": "text",
      "created_at": "text",
      "updated_at": "text"
    },
    "created_at": "text",
    "updated_at": "text"
  }
}

Obtém um produto de um aluno por ID (Assinatura)

get

Este endpoint retorna um produto (Assinatura) específico de um aluno.

Caso o aluno não seja encontrado, será lançada a exceção StudentNotFoundException.

Caso o produto não seja encontrado, será lançada a exceção ProductNotFoundException

Caso o produto/aluno informado não corresponda a uma assinatura, será lançada a exceção SubscriptionNotFoundException.

Authorizations
HTTPRequired
Path parameters
student_idstringRequired
product_idstringRequired
Responses
200

The request has succeeded.

application/json
get/students/{student_id}/products/{product_id}
GET /api/v1/students/{student_id}/products/{product_id} HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "active": 1,
    "status": "active",
    "product_id": "text",
    "payment_last_date": "text",
    "accession_date": "text",
    "expiration_date": "text",
    "cancel_date": "text",
    "product": {
      "id": "text",
      "title": "text",
      "description": "text",
      "created_at": "text",
      "updated_at": "text"
    },
    "created_at": "text",
    "updated_at": "text"
  }
}

Excluír o produto de um aluno (Assinatura)

delete

Este endpoint realiza a exclusão de uma assinatura de um aluno.

Caso o aluno não seja encontrado, será lançada a exceção StudentNotFoundException.

Caso a produto não seja encontrado, será lançada a exceção ProductNotFoundException.

Caso o produto/aluno informado não corresponda a uma assinatura, será lançada a exceção SubscriptionNotFoundException.

Authorizations
HTTPRequired
Path parameters
student_idstringRequired
product_idstringRequired
Responses
204

There is no content to send for this request, but the headers may be useful.

No content
delete/students/{student_id}/products/{product_id}
DELETE /api/v1/students/{student_id}/products/{product_id} HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Obtém as pontuações de um aluno.

get

Este endpoint retorna as pontuações de um aluno.

Caso o aluno não seja encontrado, será lançada a exceção StudentNotFoundException.

Authorizations
HTTPRequired
Path parameters
student_idstringRequired
Responses
200

The request has succeeded.

application/json
get/students/{student_id}/scores
GET /api/v1/students/{student_id}/scores HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "score": 0,
    "posts": 0,
    "comments": 0,
    "replies": 0
  }
}

Atualiza as pontuações de um aluno.

put

Este endpoint atualiza as pontuações do aluno

Caso o aluno não seja encontrado, será lançada a exceção StudentNotFoundException.

Authorizations
HTTPRequired
Path parameters
student_idstringRequired
Body
scoreintegerRequired

Valor da pontuação

Default: 0
postsintegerRead-onlyRequiredDefault: 0
commentsintegerRead-onlyRequiredDefault: 0
repliesintegerRead-onlyRequiredDefault: 0
Responses
200

The request has succeeded.

application/json
put/students/{student_id}/scores
PUT /api/v1/students/{student_id}/scores HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "score": 0
}
{
  "data": {
    "score": 0,
    "posts": 0,
    "comments": 0,
    "replies": 0
  }
}
PreviousTheMembers - API v1NextSubscriptions

Last updated