É uma sincronização parcial, onde os dados são enviados conforme necessário, através de chamadas a endpoints auxiliares, normalmente após o login do usuário na plataforma do parceiro.
O endpoint a seguir é utilizado para obter as principais informações sobre a conta de um usuário específico. Você usará esse endpoint quando precisar acessar detalhes sobre uma conta em particular.
GET /sync/v1/accounts/{account_id}?tenant_id={tenant_id}
Host: url_do_ambiente
Content-Type: application/json
Authorization: "Token de aplicação gerado com o clientId e clientSecret"
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| account_id | string | 36 | O identificador único da conta do usuário. Esse ID é necessário para especificar qual conta você deseja consultar. |
| tenant_id | string | 36 | O identificador do grupo econômico ao qual a conta pertence. Esse ID ajuda a localizar a conta dentro do contexto do grupo econômico. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| hash | string | 500 | Junção das informações encriptadas para otimização de consultas. |
| id | string | 36 | O identificador único do usuário dentro da escola. Esse ID ajuda a localizar o usuário específico na escola. |
| account_id | string | 36 | O identificador único da conta do usuário. Esse ID é utilizado para gerenciar e referenciar a conta em diferentes sistemas. |
| external_id | string | 50 | O identificador único do usuário em sistemas externos, fora do sistema principal. |
| name | string | 100 | O nome completo do usuário. |
| date_of_birth | string | 10 | A data de nascimento do usuário. (Formato YYYY-MM-DD). |
| cell_phone | CellPhone | O número de telefone do usuário. | |
| string | 200 | O endereço de e-mail principal do usuário. | |
| academic_email | string | 200 | O endereço de e-mail acadêmico do usuário |
| login | string | 50 | Login utilizado pelo usuário para acessar o sistema LEX. |
| documents | Document[] | Uma lista de documentos associados ao usuário. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| ddi | string | 5 | O codígo de discagem direta internacional. |
| value | string | 20 | O número de telefone. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| type | string | 20 | O tipo de documento (por exemplo, identidade, passaporte). |
| value | string | 20 | Número do documento. |
200 OK (Sucesso)
{
"hash": "encrypt(id+name+account_id+external_id+date_of_birth+email+documents)",
"user_id": "guid_xpto_id_user",
"account_id": "guid_xpto_id_user",
"external_id": "guid_xpto_id_user",
"name": "Aluno XPTO",
"date_of_birth": "2020-01-01",
"cell_phone": {
"ddi": "+55",
"value": "5511999999999"
},
"email": "alunoxpo@conexia.com.br",
"academic_email": "alunoxpo@conexia.com.br",
"login": "aluno.xpto",
"documents": [
{
"type": "cpf",
"value": "11111111111"
}
]
}
204 No Content (Não foi encontrado nada)
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error": {
"Code": "USR001",
"Message": "Link code errors"
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Link code errors",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
},
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id cannot be an empty GUID."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error": {
"Code": "INT500",
"Message": "An internal server error occurred."
}
}
O endpoint a seguir é utilizado para obter informações detalhadas sobre os responsáveis associados a um usuário. Você usará esse endpoint para consultar dados sobre as pessoas responsáveis pelo usuário em questão.
GET /sync/v1/accounts/{account_id}/sponsors?tenant_id={tenant_id}
Host: url_do_ambiente
Content-Type: application/json
Authorization: "Token de aplicação gerado com o clientId e clientSecret"
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| account_id | string | 36 | O identificador único da conta do usuário. |
| tenant_id | string | 36 | O identificador do grupo econômico ao qual a conta pertence. Esse ID ajuda a localizar a conta dentro do contexto do grupo econômico. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| hash | string | 500 | Junção das informações encriptadas para otimização de consultas. |
| id | string | 36 | O identificador único do responsável dentro da escola. |
| account_id | string | 36 | O identificador único da conta do responsável. |
| external_id | string | 50 | O identificador único do responsável em sistemas externos. |
| name | string | 100 | Nome completo do responsável. |
| date_of_birth | string | 10 | A data de nascimento do usuário. (Formato YYYY-MM-DD). |
| cell_phone | CellPhone | O número de telefone do usuário. | |
| string | 200 | O endereço de e-mail do responsável. | |
| documents | Document[] | Uma lista de documentos associados ao responsável. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| ddi | string | 5 | O codígo de discagem direta internacional. |
| value | string | 20 | O número de telefone. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| type | string | 20 | O tipo de documento (por exemplo, identidade, passaporte). |
| value | string | 20 | O valor ou número do documento. |
Em resumo, o endpoint fornece informações detalhadas sobre os responsáveis pelo usuário, incluindo identificadores, dados pessoais, informações de contato, e documentos associados. Isso ajuda a obter um panorama completo dos responsáveis envolvidos com o usuário em questão.
200 OK (Sucesso)
[
{
"hash": "encrypt(id+name+account_id+external_id+date_of_birth+email+documents)",
"id": "guid_xpto_id_user",
"account_id": "guid_xpto_id_user",
"external_id": "PAI_XPTO",
"name": "Pai XPTO",
"date_of_birth": "2000-01-01",
"cell_phone": {
"ddi": "+55",
"value": "5511999999999"
},
"email": "paixpo@conexia.com.br",
"documents": [
{
"type": "cpf",
"value": "11111111111"
}
]
},
{
"hash": "encrypt(id+name+account_id+external_id+date_of_birth+email+documents)",
"id": "guid_xpto_id_user",
"account_id": "guid_xpto_id_user",
"external_id": "Mae_XPTO",
"name": "Mae XPTO",
"date_of_birth": "2000-01-01 00:00:00.000",
"cell_phone": {
"ddi": "+55",
"value": "5511999999999"
},
"email": "maexpo@conexia.com.br",
"documents": [
{
"type": "cpf",
"value": "11111111111"
}
]
}
]
204 No Content (Não foi encontrado nada)
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error": {
"Code": "USR001",
"Message": "Link code errors"
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Link code errors",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
},
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id cannot be an empty GUID."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error": {
"Code": "INT500",
"Message": "An internal server error occurred."
}
}
Este endpoint é utilizado para obter informações detalhadas sobre os dependentes associados a um usuário responsável.
GET /sync/v1/accounts/{account_id}/dependents?tenant_id={tenant_id}
Host: url_do_ambiente
Content-Type: application/json
Authorization: "Token de aplicação gerado com o clientId e clientSecret"
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| account_id | string | 36 | O identificador único da conta do usuário para o qual você deseja recuperar os dependentes. |
| tenant_id | string | 36 | O identificador do grupo econômico ao qual a conta do usuário pertence. Esse ID é usado para localizar a conta dentro do contexto do grupo econômico. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| hash | string | 500 | Junção das informações encriptadas para otimização de consultas. |
| id | string | 36 | O identificador único do dependente dentro da escola. |
| account_id | string | 36 | O identificador único da conta do dependente. |
| external_id | string | 50 | O identificador único do usuário em sistemas externos. |
| name | string | 100 | Nome completo do dependente. |
| date_of_birth | string | 10 | A data de nascimento do usuário. (Formato YYYY-MM-DD). |
| cell_phone | CellPhone | O número de telefone do usuário. | |
| string | 200 | O endereço de e-mail do dependente. | |
| academic_email | string | 200 | O endereço de e-mail acadêmico do dependente |
| login | string | 50 | Login utilizado pelo dependente para acessar o sistema LEX. |
| documents | Document[] | Uma lista de documentos associados ao dependente. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| ddi | string | 5 | O codígo de discagem direta internacional. |
| value | string | 20 | O número de telefone. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| type | string | 20 | O tipo de documento (por exemplo, identidade, passaporte). |
| value | string | 20 | O valor ou número do documento. |
Em resumo, o endpoint fornece informações detalhadas sobre os dependentes do usuário, incluindo identificadores, dados pessoais, informações de contato, e documentos associados. Isso ajuda a obter um panorama completo dos dependentes vinculados ao usuário.
200 OK (Sucesso)
[
{
"hash": "encrypt(id+name+account_id+external_id+date_of_birth+email+documents)",
"id": "guid_xpto_id_user",
"account_id": "guid_xpto_id_user",
"external_id": "Filho_XPTO",
"name": "Filho XPTO",
"date_of_birth": "2020-01-01",
"cell_phone": {
"ddi": "+55",
"value": "5511999999999"
},
"email": "Filhoxpo@conexia.com.br",
"academic_email": "Filhoxpo@conexia.com.br",
"login": "filho_xpto",
"documents": [
{
"type": "cpf",
"value": "11111111111"
}
]
},
{
"hash": "encrypt(id+name+account_id+external_id+date_of_birth+email+documents)",
"id": "guid_xpto_id_user",
"account_id": "guid_xpto_id_user",
"name": "FILHA XPTO",
"date_of_birth": "2020-01-01",
"phone": "5511999999999",
"email": "FILHAxpo@conexia.com.br",
"academic_email": "FILHAxpo@conexia.com.br",
"login": "filha_xpto",
"external_id": "FILHA_XPTO",
"documents": [
{
"type": "cpf",
"value": "11111111111"
}
]
}
]
204 No Content (Não foi encontrado nada)
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error": {
"Code": "USR001",
"Message": "Link code errors"
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Link code errors",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
},
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id cannot be an empty GUID."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error": {
"Code": "INT500",
"Message": "An internal server error occurred."
}
}
Este endpoint é utilizado para obter informações detalhadas sobre um grupo econômico específico. Um grupo econômico pode ser uma entidade que agrupa várias escolas, empresas ou outras instituições.
Para obter informações sobre o grupo econômico, você deve fazer uma requisição do tipo GET para o endpoint a seguir:
GET /sync/v1/tenants/{tenant_id}
Host: url_do_ambiente
Content-Type: application/json
Authorization: "Token de aplicação gerado com o clientId e clientSecret"
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| tenant_id | string | 36 | Id do grupo econômico. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| hash | string | 500 | Junção das informações encriptadas para otimização de consultas. |
| id | string | 36 | O identificador único do grupo econômico sobre o qual você deseja recuperar informações. |
| name | string | 100 | O nome oficial do grupo econômico. Pode ser o nome da rede de escolas, empresa ou outra organização. |
| external_id | string | 50 | Um identificador único do grupo econômico que pode ser utilizado em sistemas externos ou em outras integrações. |
| brand_name | string | 50 | A marca ou nome comercial associado ao grupo econômico. |
Em resumo, o endpoint fornece informações principais sobre um grupo econômico, como seu ID, nome, identificadores externos e marca associada. Isso é útil para entender a estrutura e a identidade do grupo econômico no sistema.
200 OK (Sucesso)
{
"hash": "encrypt(id+name+external_id+brand_name)",
"id": "guid_xpto_id_tenant",
"name": "Grupo Econômico XPTO",
"external_id": "G01234",
"brand_name": "Marca"
}
204 No Content (Não foi encontrado nada)
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error": {
"Code": "USR001",
"Message": "Link code errors"
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Link code errors",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
},
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id cannot be an empty GUID."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error": {
"Code": "INT500",
"Message": "An internal server error occurred."
}
}
Este endpoint é utilizado para obter informações detalhadas sobre as escolas associadas a um usuário específico. Essas informações são úteis para identificar e entender os detalhes das escolas relacionadas ao usuário no sistema.
Para obter informações sobre as escolas, você deve fazer uma requisição do tipo GET para o endpoint a seguir:
GET /sync/v1/schools/{account_id}?tenant_id={tenant_id}
Host: url_do_ambiente
Content-Type: application/json
Authorization: "Token de aplicação gerado com o clientId e clientSecret"
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| account_id | string | 36 | O identificador único da conta do usuário. |
| tenant_id | string | 36 | O identificador do grupo econômico ao qual as escolas pertencem. Esse ID ajuda a filtrar as escolas dentro do contexto do grupo econômico específico. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| hash | string | 500 | Junção das informações encriptadas para otimização de consultas. |
| id | string | 36 | O identificador único da escola. Esse ID é utilizado para referenciar a escola dentro do sistema. |
| name | string | 50 | Nome da escola. |
| cnpj | string | 18 | O CNPJ (Cadastro Nacional da Pessoa Jurídica) da escola. Esse é um documento de identificação fiscal da escola no Brasil. |
| external_id | string | 50 | Um identificador único da escola utilizado em sistemas externos ou integrações. |
| addresses | Address[] | Uma lista de endereços associados à escola. | |
| string | 200 | O endereço de e-mail da escola. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| zip | string | 10 | O código postal (CEP) da escola. |
| city | string | 50 | O nome da cidade onde a escola está localizada. |
| state | string | 2 | O estado onde a escola está localizada. |
| address | string | 100 | Endereço da escola. |
| number | string | 10 | O número do prédio ou lote da escola. |
| neighborhood | string | 50 | O bairro onde a escola está localizada. |
| complement | string | 50 | Qualquer informação adicional do endereço da escola, como sala ou bloco. |
Em resumo, este endpoint fornece informações abrangentes sobre as escolas associadas a um usuário, incluindo dados de contato, localização e identificação.
200 OK (Sucesso)
[
{
"hash": "encrypt(id+name+cpnj+external_id+addresses)",
"id": "1234567890abcdefg",
"external_id": "ESC123",
"name": "Turma Xpto",
"cpnj": "11.111.111/0001-20",
"addresses": [
{
"Zip": "11111-000",
"City": "Cidade",
"State": "SP",
"address": "Avenida Marechal Deodoro da Fonseca",
"number": "123",
"neighborhood": "Bairro XPTO",
"complement": "Proximo ao mercado"
}
],
"email": "turma@email.om"
}
]
204 No Content (Não foi encontrado nada)
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error": {
"Code": "USR001",
"Message": "Link code errors"
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Link code errors",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
},
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id cannot be an empty GUID."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error": {
"Code": "INT500",
"Message": "An internal server error occurred."
}
}
Endpoint responsável por recuperar as principais informações da turmas do usuário:
GET /sync/v1/accounts/{account_id}/classes?tenant_id={tenant_id}
Host: url_do_ambiente
Content-Type: application/json
Authorization: "Token de aplicação gerado com o clientId e clientSecret"
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| account_id | string | 36 | Id da conta do usuário. |
| tenant_id | string | 36 | ID do grupo econômico. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| hash | string | 500 | Junção das informações encriptadas para otimização de consultas. |
| id | string | 36 | Id da turma. |
| name | string | 100 | Nome da turma. |
| school_id | string | 36 | Id da escola. |
| external_id | string | 50 | Identificador da turma. |
| course_code | string | 50 | Codígo do curso que contem na turma. |
| description | string | 500 | Descrição da turma. |
| year | int | 4 | Ano letivo da turma. |
| educational_stage | EducationalStage | Segmento da turma. | |
| grade | Grade | Seríe da turma. | |
| profiles | Profile[] | Lista de perfis que o usuário possui na turma. | |
| subjects | Subject[] | Lista de disciplinas que o usuário possui na turma. | |
| shift | Shift | Turno da turma. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| id | string | 36 | Id do segmento. |
| name | string | 80 | Nome do segmento. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| id | string | 36 | Id da serie. |
| name | string | 80 | Nome da serie. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| id | string | 36 | Id do perfil. |
| name | string | 64 | Nome do perfil. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| id | string | 36 | Id da disciplina. |
| name | string | 50 | Nome da disciplina. |
| Parâmetro | Tipo | Tamanho | Descrição |
|---|---|---|---|
| id | string | 36 | Id do turno. |
| name | string | 80 | Nome do turno. |
200 OK (Sucesso)
[
{
"hash": "encrypt(id+name+school_id+external_id+course_code+description+year+educational_stage+grade+profiles+subjects+shift)",
"id": "1234567890abcdefg",
"name": "Turma XPTO",
"school_id": "1234567890abcdefg",
"external_id": "TU421",
"course_code": "C123",
"description": "Descrição da Turma XPTO",
"year": 2024,
"educational_stage": {
"id": "1234567890abcdefg",
"name": "EF1"
},
"grade": {
"id": "1234567890abcdefg",
"name": "EF1"
},
"profiles": [
{
"id": "1234567890abcdefg",
"name": "Coordenador"
}
],
"subjects": [
{
"id": "1234567890abcdefg",
"name": "Matematica"
}
],
"shift": {
"tagId": "1234567890abcdefg",
"name": "Integral"
}
}
]
204 No Content (Não foi encontrado nada)
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error": {
"Code": "USR001",
"Message": "Link code errors"
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Link code errors",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
},
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id cannot be an empty GUID."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error": {
"Code": "INT500",
"Message": "An internal server error occurred."
}
}