Consultar Planos do Aluno

Route (Rota)

Método	Rota	Descrição
GET	`webservice/student/plans`	Retorna o aluno e os planos vinculados a ele.

Headers (Cabeçalho)

Param	Tipo	Descrição	Obrigatório
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

Query 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

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

Exemplos

cURL

				
					curl --location 'https://sua.plataforma.com/student/plans?student_id=3' \
--header 'Accept: application/json' \
--header 'secret: {{._webservice_secret}}' \
--header 'token: {{._webservice_token}}'

Node.js

				
					const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://sua.plataforma.com/student/plans?student_id=3',
  headers: { 
    'Accept': 'application/json', 
    'secret': '{{._webservice_secret}}', 
    'token': '{{._webservice_token}}'
  }
};

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

PHP

				
					<?php
$client = new Client();
$headers = [
  'Accept' => 'application/json',
  'secret' => '{{._webservice_secret}}',
  'token' => '{{._webservice_token}}'
];
$request = new Request('GET', 'https://sua.plataforma.com/student/plans?student_id=3', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

Response (Respostas)

- Aluno encontrado (Status: 200)

				
					{
  "message": "Aluno Encontrado",
  "status": "200",
  "data": {
    "student": {
      "id": "1",
      "document_type": "CPF",
      "document": "999.999.999-99",
      "geographic_lock": "0",
      "profile": {
        "instagram": null,
        "facebook": null,
        "twitter": null,
        "linkedin": null,
        "website": null,
        "picture": null
      },
      "user": {
        "name": "Aluno",
        "email": "email@email.com",
        "expires_at": null
      },
      "secondaries": [],
      "form": null
    },
    "plans": [
      {
        "status": "0",
        "available": "1",
        "due_date": null,
        "plan": {
          "id": "1",
          "type": "3",
          "sale_type": "UNIQUE",
          "days": null,
          "start_date": null,
          "end_date": null,
          "url": "https://plataforma-nochalks.com/plans/plano",
          "category": null,
          "translation": {
            "name": "Plano",
            "description": "<p>Plano de Teste<\/p>",
            "language_id": "1"
          }
        }
      }
    ]
  }
}