MindzJs V1

Introdução

MindzJs V1 é uma biblioteca JavaScript projetada para simplificar a integração com a API pública da aplicação Mindz. Esta biblioteca oferece métodos simplificados para realizar operações relacionadas a cursos, bundles, planos, estatísticas, declarações, newsletter e contato.

Como Usar | Instalação

Para começar a utilizar o MindzJs V1, inclua o script no seu projeto:

<script src="https://cdn.ead.guru/static/API/mindz.js"></script>

Uso Básico

A biblioteca fornece classes para diferentes entidades, como cursos, bundles, planos, etc. Cada classe possui métodos para recuperar dados específicos da API pública.

Exemplo: Obtendo informações sobre um curso

const myCourse = new Course("curso-slug");
await myCourse.get();
console.log(myCourse.data); // Exibe os dados do curso

Exemplo: Registrando um usuário na newsletter

const myNewsletter = new Newsletter();
const userData = { email: "user@example.com", code: "123", first_name: "John", last_name: "Doe" };
await myNewsletter.registerUser(userData);
console.log(myNewsletter.data); // Exibe os dados do usuário registrado na newsletter

Exemplo: Enviando uma mensagem de contato

const myContact = new Contact();
const validSubjects = ["Comercial", "Suporte", "Denúncia", "Bugs e falhas"];
const messageData = { name: "John Doe", email: "john.doe@example.com", subject: "Suporte", message: "Hello, I have a question." };
if (validSubjects.includes(messageData.subject)) {
    await myContact.sendMessage(messageData);
    console.log(myContact.data); // Exibe os dados da mensagem de contato enviada
} else {
    console.error("Assunto inválido. Os assuntos permitidos são: Comercial, Suporte, Denúncia, Bugs e falhas.");
}

Classes Disponíveis

Course

constructor(slug): Cria uma instância do curso com base no slug.
async get(): Obtém informações detalhadas sobre o curso.
async getScore(): Obtém a pontuação do curso.

Bundle

constructor(slug): Cria uma instância do bundle com base no slug.
async get(): Obtém informações detalhadas sobre o bundle.

Plan

constructor(slug): Cria uma instância do plano com base no slug.
async get(): Obtém informações sobre o plano.

Plans

constructor(): Cria uma instância de planos.
async get(data): Obtém uma lista de planos com base nos parâmetros fornecidos.

Parâmetros:
data: Objeto contendo os parâmetros limit, offset, ordering, search.

Bundles

constructor(): Cria uma instância de bundles.
async get(data): Obtém uma lista de bundles com base nos parâmetros fornecidos.

Parâmetros:
data: Objeto contendo os parâmetros limit, offset, ordering, search.

Courses

constructor(): Cria uma instância de cursos.
async get(data): Obtém uma lista de cursos com base nos parâmetros fornecidos.

Parâmetros:
data: Objeto contendo os parâmetros limit, offset, ordering, search.

Products

constructor(): Cria uma instância de produtos.
async get(): Obtém uma lista de produtos.

Statements

constructor(): Cria uma instância de declarações.
async get(): Obtém informações sobre declarações.

Stats

constructor(): Cria uma instância de estatísticas.
async get(): Obtém estatísticas gerais.

Newsletter

constructor(): Cria uma instância para registro na newsletter.
async registerUser(data): Registra um usuário na newsletter.

Parâmetros:
data: Objeto contendo os parâmetros email, code, first_name, last_name.

Contact

constructor(): Cria uma instância para registro de contato.
async sendMessage(data): Envia uma mensagem de contato.

Parâmetros:
data: Objeto contendo os parâmetros name, email, subject, message. O subject deve ser escolhido entre as opções: Comercial, Suporte, Denúncia, Bugs e falhas.

Atualizado em: 07/02/2024