API LCE Students - Documentação

POST /lce-students/import

Importar estudantes a partir de arquivo XLSX (Essa funcionalidade precisa estar habilitada no sistema)

Parâmetros:

secret (Header) *obrigatório

Chave secreta para autenticação da requisição

file (FormData) *obrigatório

Arquivo XLSX com colunas E-mail e CPF

Exemplo de uso:

curl -X POST https://lce.api.zipcloud.com.br/lce-students/import \
                     -F "file=@estudantes.xlsx"

Resposta:

{
  "message": "Importação concluída",
  "success": 15,
  "skipped": 3
}

POST /general-students/import

Importar estudantes a partir de arquivo XLSX (Essa funcionalidade precisa estar habilitada no sistema)

Parâmetros:

secret (Header) *obrigatório

Chave secreta para autenticação da requisição

file (FormData) *obrigatório

Arquivo XLSX com colunas Documento e Email

Exemplo de uso:

curl -X POST https://lce.api.zipcloud.com.br/general-students/import \
                     -F "file=@estudantes.xlsx"

Resposta:

{
  "message": "Importação concluída",
  "success": 15,
  "skipped": 3
}

GET /lce-students/verify/:{document}

Verificar se documento existe na base de estudantes lce

Parâmetros:

secret (Header) *obrigatório

Chave secreta para autenticação da requisição

document (URL Parameter) *obrigatório

CPF, email ou CNPJ

Exemplo de uso:

curl https://lce.api.zipcloud.com.br/lce-students/verify/ola@oi.com

Resposta:

{ "exists": true, documenType: "email" }

GET /general-students/verify/:{document}

Verificar se documento existe na base de estudantes geral

Parâmetros:

secret (Header) *obrigatório

Chave secreta para autenticação da requisição

document (URL Parameter) *obrigatório

CPF, email ou CNPJ

Exemplo de uso:

curl https://lce.api.zipcloud.com.br/general-students/verify/12345678900

Resposta:

{ "exists": true, documenType: "cpf" }

GET /

Documentação da API (esta página)

Exemplo de uso:

curl https://lce.api.zipcloud.com.br/

Resposta:

HTML desta página