{ "name": "João da Silva", "email": "[email protected]", "cpf": "12345678900", "schools": [1, 2], "password": "Senha123", "origin": "API" }

Code Block (cURL):

bash curl -X POST
'https://api.toolzz.dev/lms/users'
-H 'Authorization: Bearer SEU_TOKEN'
-H 'Content-Type: application/json'
-d '{ "name": "João da Silva", "email": "[email protected]", "cpf": "12345678900", "schools": [1, 2], "password": "Senha123", "origin": "API" }'

Code Block (JavaScript - Fetch API):

javascript const url = 'https://api.toolzz.dev/lms/users'; const data = { name: 'João da Silva', email: '[email protected]', cpf: '12345678900', schools: [1, 2], password: 'Senha123', origin: 'API' };

fetch(url, { method: 'POST', headers: { 'Authorization': 'Bearer SEU_TOKEN', 'Content-Type': 'application/json' }, body: JSON.stringify(data) }) .then(response => response.json()) .then(data => console.log(data)) .catch(error => console.error('Error:', error));

Code Block (Python - Requests):

python import requests import json

url = 'https://api.toolzz.dev/lms/users' headers = { 'Authorization': 'Bearer SEU_TOKEN', 'Content-Type': 'application/json' } data = { 'name': 'João da Silva', 'email': '[email protected]', 'cpf': '12345678900', 'schools': [1, 2], 'password': 'Senha123', 'origin': 'API' }

response = requests.post(url, headers=headers, data=json.dumps(data)) print(response.json())

Tabela de Parâmetros:

Response JSON de Exemplo:

{ "id": 123, "name": "João da Silva", "email": "[email protected]", "cpf": "12345678900", "schools": [1, 2], "origin": "API", "created_at": "2024-10-27T10:00:00.000Z", "updated_at": "2024-10-27T10:00:00.000Z" }

Criar Turmas

Este endpoint permite criar uma nova turma dentro da plataforma Toolzz LXP.

• URL: https://api.toolzz.dev/lms/classes
• Método: POST
• Headers:
  • Authorization: Bearer SEU_TOKEN
  • Content-Type: application/json

Body JSON de Exemplo:

{ "course_id": 1, "name": "Turma de Vendas - Outubro 2024", "start_date": "2024-10-28", "end_date": "2024-12-28", "instructor_id": 456, "capacity": 50 }

Code Block (cURL):

bash curl -X POST
'https://api.toolzz.dev/lms/classes'
-H 'Authorization: Bearer SEU_TOKEN'
-H 'Content-Type: application/json'
-d '{ "course_id": 1, "name": "Turma de Vendas - Outubro 2024", "start_date": "2024-10-28", "end_date": "2024-12-28", "instructor_id": 456, "capacity": 50 }'

Code Block (JavaScript - Fetch API):

javascript const url = 'https://api.toolzz.dev/lms/classes'; const data = { course_id: 1, name: 'Turma de Vendas - Outubro 2024', start_date: '2024-10-28', end_date: '2024-12-28', instructor_id: 456, capacity: 50 };

fetch(url, { method: 'POST', headers: { 'Authorization': 'Bearer SEU_TOKEN', 'Content-Type': 'application/json' }, body: JSON.stringify(data) }) .then(response => response.json()) .then(data => console.log(data)) .catch(error => console.error('Error:', error));

Code Block (Python - Requests):

python import requests import json

url = 'https://api.toolzz.dev/lms/classes' headers = { 'Authorization': 'Bearer SEU_TOKEN', 'Content-Type': 'application/json' } data = { 'course_id': 1, 'name': 'Turma de Vendas - Outubro 2024', 'start_date': '2024-10-28', 'end_date': '2024-12-28', 'instructor_id': 456, 'capacity': 50 }

response = requests.post(url, headers=headers, data=json.dumps(data)) print(response.json())

Tabela de Parâmetros:

Response JSON de Exemplo:

{ "id": 789, "course_id": 1, "name": "Turma de Vendas - Outubro 2024", "start_date": "2024-10-28", "end_date": "2024-12-28", "instructor_id": 456, "capacity": 50, "created_at": "2024-10-27T10:00:00.000Z", "updated_at": "2024-10-27T10:00:00.000Z" }

Matricule alunos em uma turma

Este endpoint permite matricular um ou mais alunos em uma turma existente.

• URL: https://api.toolzz.dev/lms/classes/{class_id}/enroll
• Método: POST
• Headers:
  • Authorization: Bearer SEU_TOKEN
  • Content-Type: application/json

Body JSON de Exemplo:

{ "user_ids": [123, 456, 789] }

Code Block (cURL):

bash curl -X POST
'https://api.toolzz.dev/lms/classes/789/enroll'
-H 'Authorization: Bearer SEU_TOKEN'
-H 'Content-Type: application/json'
-d '{ "user_ids": [123, 456, 789] }'

Code Block (JavaScript - Fetch API):

javascript const classId = 789; const url = https://api.toolzz.dev/lms/classes/${classId}/enroll; const data = { user_ids: [123, 456, 789] };

fetch(url, { method: 'POST', headers: { 'Authorization': 'Bearer SEU_TOKEN', 'Content-Type': 'application/json' }, body: JSON.stringify(data) }) .then(response => response.json()) .then(data => console.log(data)) .catch(error => console.error('Error:', error));

Code Block (Python - Requests):

python import requests import json

class_id = 789 url = f'https://api.toolzz.dev/lms/classes/{class_id}/enroll' headers = { 'Authorization': 'Bearer SEU_TOKEN', 'Content-Type': 'application/json' } data = { 'user_ids': [123, 456, 789] }

response = requests.post(url, headers=headers, data=json.dumps(data)) print(response.json())

Tabela de Parâmetros:

Response JSON de Exemplo:

{ "message": "Alunos matriculados com sucesso", "enrolled_users": [123, 456, 789] }

Webhooks: Mantendo seu Sistema Atualizado

Os webhooks são notificações push que o Toolzz LXP envia para o seu sistema externo quando eventos importantes ocorrem. Para o caso de uso de matrícula automatizada, os seguintes webhooks são relevantes:

• Novo cadastro: Disparado quando um novo usuário é criado na plataforma.
• Nova matrícula: Disparado quando um aluno é matriculado em uma turma.
• Curso concluído: Disparado quando um aluno completa um curso.

Para configurar um webhook, siga os seguintes passos:

1. Acesse o menu Administração > Webhooks na plataforma Toolzz LXP.
2. Clique em Novo Webhook.
3. Selecione o evento que deseja monitorar (por exemplo, Nova matrícula).
4. Informe a URL do seu sistema externo para onde a notificação será enviada.
5. Salve as configurações.

Payload de Exemplo (Novo cadastro):

{ "event": "novo_cadastro", "data": { "id": 123, "name": "João da Silva", "email": "[email protected]", "created_at": "2024-10-27T10:00:00.000Z" } }

Seu sistema externo deve estar preparado para receber e processar os payloads dos webhooks. Ao receber uma notificação, você pode atualizar seus dados locais, enviar e-mails de boas-vindas, etc.

Testando a Automação

Após implementar a automação da matrícula via API, é fundamental realizar testes para garantir que tudo está funcionando corretamente. Siga os seguintes passos:

1. Crie um novo usuário através da API.
2. Crie uma nova turma através da API.
3. Matricule o usuário na turma através da API.
4. Acesse a plataforma Toolzz LXP e verifique se o usuário foi criado e matriculado na turma corretamente.
5. Configure os webhooks e verifique se as notificações estão sendo enviadas para o seu sistema externo.

Erros Comuns e Soluções

Ao implementar a automação da matrícula via API, você pode encontrar alguns erros comuns. Veja como solucioná-los:

• 401 Unauthorized: O token de autenticação está incorreto ou expirado. Verifique se o token está correto e gere um novo se necessário.
• 400 Bad Request: A requisição está mal formatada ou os dados são inválidos. Verifique se o body da requisição está no formato JSON correto e se os dados estão de acordo com as especificações da API.
• 404 Not Found: O recurso solicitado não foi encontrado. Verifique se a URL está correta e se o ID da turma ou do usuário existe na plataforma.
• 500 Internal Server Error: Ocorreu um erro interno no servidor da API. Tente novamente mais tarde ou entre em contato com o suporte da Toolzz.

Conclusão

A automação da matrícula de alunos via API do Toolzz LXP é uma solução poderosa para otimizar a gestão educacional em empresas. Ao integrar sistemas externos com a plataforma, é possível reduzir o tempo e os recursos gastos com tarefas manuais, além de melhorar a experiência do aluno e do administrador. A Toolzz oferece uma API completa e flexível, que permite automatizar diversos processos e personalizar a plataforma de acordo com as necessidades da sua empresa.

Automatize ainda mais com agentes de IA da Toolzz: Conecte o LXP com Toolzz AI. E se em vez de chamar a API manualmente, um agente de IA fizesse isso por você? Com a Toolzz AI, crie um agente que matricula alunos, consulta notas e gera relatórios — tudo por WhatsApp. Já imaginou o gestor perguntar pelo WhatsApp: 'Matricula o João no curso de vendas' e o agente executar na hora?