Ativação do plano do Aluno

Route (Rota)

Método	Rota	Descrição
PUT	`webservice/student/plan/{plan_id}/status`	Ativa ou desativa o plano para o aluno

*Quando a funcionalidade “Confirmação de Matrícula” está ativa, todos os planos precisam ser ativados manualmente por essa rota pelo Administrador da plataforma, para que o Aluno tenha acesso ao conteúdo. Para ativar essa funcionalidade é necessário entrar em contato com nosso time de suporte.

Headers (Cabeçalho)

Param	Tipo	Descrição	Obrigatório
Accept	`String`	application/json	Sim
content-type	`String`	application/json	Sim
secret	`String`	*Secret Key	Sim
token	`String`	**Webservice Token	Sim

*Para conseguir a Secret Key acesse sua Plataforma, abra o Menu, vá na área de Usuários e acesse Webservice, lá você terá a lista de usuários com suas respectivas Secret Key

** Token gerado pela rota de autenticação

Route params (Parâmetros da Rota)

Param	Tipo	Descrição	Obrigatório
plan_id	`String`	Id do plano	Sim

* Os tipos de documentos padrões da plataforma são: CPF, RG e CNPJ

Body params (Parâmetros)

Param	Tipo	Descrição	Obrigatório
student_id	`String`	Id do aluno	Não
document_type	`String`	*Tipo de documento - Ex.: CPF	Não
document	`String`	Documento do aluno - Ex.: XXX.XXX.XXX-XX	Não
status	`String`	Status do Plano	Não

* Os tipos de documento padrão da plataforma são: CPF, RG e CNPJ

Exemplos

cURL

				
					curl --location --globoff --request PUT 'https://sua.plataforma.com/student/plan/{{student_id}}/status' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'secret: {{._webservice_sercret}}' \
--header 'token: {{._webservice_token}}' \
--data-raw '{
  "field_name": "email",
  "field_value": "teste@soujmv.com",
  "status": 0
}'

Node.js

				
					const axios = require('axios');
let data = JSON.stringify({
  "field_name": "email",
  "field_value": "teste@soujmv.com",
  "status": 0
});

let config = {
  method: 'put',
  maxBodyLength: Infinity,
  url: 'https://sua.plataforma.com/student/plan/{{student_id}}/status',
  headers: { 
    'Content-Type': 'application/json', 
    'Accept': 'application/json', 
    'secret': '{{._webservice_sercret}}', 
    'token': '{{._webservice_token}}'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

PHP

				
					<?php
$client = new Client();
$headers = [
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'secret' => '{{._webservice_sercret}}',
  'token' => '{{._webservice_token}}'
];
$body = '{
  "field_name": "email",
  "field_value": "teste@soujmv.com",
  "status": 0
}';
$request = new Request('PUT', 'https://sua.plataforma.com/student/plan/{{student_id}}/status', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

Requests (Requisições)

- Request com ID do Aluno)

				
					{
	"student_id": 1,
	"status": 1
}

- Request com Documento do Aluno

				
					{
	"document_type": "cpf",
	"document": "999.999.999-99",
	"status": 1
}

Response (Respostas)

- Aluno atualizado (Status: 200)

				
					{
    "message": "Aluno atualizado",
    "status": "200",
    "data": {
        "id": "1",
        "document_type": "CPF",
        "document": "999.999.999-99",
        "profile": {
            "instagram": "http:\/\/instagram.com\/aluno2",
            "facebook": "http:\/\/facebook.com\/aluno2",
            "twitter": null,
            "linkedin": null,
            "website": "http:\/\/mywebsite.com\/aluno2",
            "picture": ""
        },
        "geographic_lock": "0",
        "user": {
            "name": "aluno0",
            "email": "aluno0owner@nochalks.com.br",
            "expires_at": null
        },
        "secondaries": [
            {
                "name": "aluno0",
                "email": "aluno0secondary@nochalks.com.br",
                "expires_at": null
            }
        ],
        "form": null
    }
}