Esta documentação apresenta um guia completo e detalhado para realizar a integração com a plataforma LEX. Cada etapa do processo é explicada no contexto em que é utilizada, com exemplos de requisição e resposta.
A configuração inicial é essencial para preparar o ambiente de integração. Isso inclui a criação da escola, a configuração do integrador e a associação de escolas ao integrador.
School External ID para referência única.Client ID e o Client Secret.ExternalIntegrationId da escola no banco de dados.Antes de cadastrar turmas ou usuários, é necessário consultar os perfis disponíveis, bem como os segmentos e séries associados à escola.
Para maiores informações do funcionamento do endpoint, clique aqui.
GET /data/v1/profilesgrant_type do tipo client_credentials.type como parâmetro nos cadastros.Exemplo de Resposta:
{
"data": [
{
"code": 1,
"name": "Aluno",
"type": "student",
"description": "Acessa o Painel de Produtos."
},
{
"code": 2,
"name": "Coordenador",
"type": "coordinator",
"description": "Responsável pela coordenação de turmas."
}
]
}
Para maiores informações do funcionamento do endpoint, clique aqui.
GET /data/v1/educational-stages?school_external_id={school_external_id}name para associar os segmentos e séries às turmas.Exemplo de Resposta:
{
"data": [
{
"name": "EI",
"description": "EDUCAÇÃO INFANTIL",
"grades": [
{
"name": "EI1",
"description": "EDUCAÇÃO INFANTIL 01 ANO"
}
]
}
]
}
Para maiores informações do funcionamento do endpoint, clique aqui.
POST /integration/partner/v1/classeducational_stage e grade.Exemplo de Payload:
{
"school_external_id": "E0064",
"external_id": "turma-luciane3",
"educational_stage": "EFI",
"grade": "EF1",
"shift": null,
"year": 2024,
"code": "061120241",
"name": "Turma Luciane API2",
"description": "",
"course": null
}
Exemplo de Resposta:
{
"data": {
"id": "123456",
"external_id": "turma-luciane3",
"name": "Turma Luciane API2",
"status": "active"
}
}
Para maiores informações do funcionamento do endpoint, clique aqui.
responsible_external_id.POST /integration/partner/v1/userresponsible.Exemplo de Payload:
{
"external_id": "061120242",
"first_name": "Lucas",
"last_name": "ResponsavelLuciane",
"birth_date": "2000-01-01",
"document_type": "CPF",
"document_value": "764.030.250-15",
"ddi": "55",
"cell_phone": "51998161300",
"email": "lucasresponsavelviaapir@gmail.com",
"profiles": [
"responsible"
],
"school_external_id": "E0064"
}
POST /integration/partner/v1/userresponsible_external_id com os IDs dos responsáveis.student e envie a requisição.Exemplo de Payload:
{
"external_id": "061120243",
"first_name": "João",
"last_name": "AlunoLuciane",
"birth_date": "2010-05-15",
"document_type": "CPF",
"document_value": "123.456.789-10",
"ddi": "55",
"cell_phone": "51998161234",
"email": "joaoalunoviaapi@gmail.com",
"profiles": [
"student"
],
"responsible_external_id": [
"061120242"
],
"school_external_id": "E0064"
}
Para maiores informações do funcionamento do endpoint, clique aqui.
Contexto: Realizar o processo de enturmação de usuários, vinculando-os às turmas.
Endpoint:
POST /integration/partner/v1/bond-user-class
Passo a Passo:
school_external_id: External ID da escola.class_external_id: External ID da turma.user_external_id: External ID do usuário.profile_name: Perfil do usuário (educator, student, coordinator etc.).{
"school_external_id": "E0064",
"class_external_id": "turma-api-2102",
"user_external_id": "040920236",
"profile_name": "educator"
}
Para maiores informações do funcionamento do endpoint, clique aqui.
Contexto: Realizar o processo de desenturmação de usuários, desvinculando-os às turmas.
Endpoint:
DELETE /integration/partner/v1/bond-user-class
Passo a Passo:
school_external_id: External ID da escola.class_external_id: External ID da turma.user_external_id: External ID do usuário.profile_name: Perfil do usuário a ser desvinculado (educator, student, etc.).DELETE com o token de autenticação.{
"school_external_id": "E0064",
"class_external_id": "turma-api-2102",
"user_external_id": "040920236",
"profile_name": "educator"
}
Para maiores informações do funcionamento do endpoint, clique aqui.
account_id e o user_id gerados.GET /integration/partner/v1/callbackExemplo de Resposta:
{
"data": {
"account_id": "123456",
"user_id": "7891011",
"status": "created"
}
}