Fluxo de importação
Introdução à Documentação de Importação de Dados - Plataforma Layers
Bem-vindo(a) à documentação sobre o Fluxo de Importação de Dados na plataforma Layers. Esta seção é projetada para fornecer uma visão detalhada do processo de integração, sendo essencial para Product Managers, Tech Leads, Desenvolvedores e Analistas de Negócio.
Modelo de Importação de Dados:
Dois Métodos de Integração:
Método Incremental:
- Sincronização total e incremental.
- Importação de todos os dados e atualização apenas dos modificados desde a última sincronização.
- Flexibilidade na gestão de atualizações, evitando custos desnecessários de requisições.
Método Total:
- Sincronizações totais em intervalos diários.
- Integração completa dos dados da comunidade/escola em ambos os sistemas.
- Recomendado para frequência diária aceitável e carga de dados gerenciável.
Dados Integrados:
A Importação de Dados compreende quatro entidades principais:
- Usuários (users);
- Alunos (members);
- Turmas (groups);
- Disciplinas (components).
A sincronização ocorre em intervalos pré-definidos, estabelecidos pela Layers em colaboração com o sistema integrado, assegurando uma experiência de usuário contínua.
Fluxo de Integração de Importação de Dados:
1. Solicitação da Integração:
Solicitando a Integração:
- Envie um e-mail para suporte@layers.education, declarando o interesse na integração e fornecendo detalhes sobre os requisitos.
Primeiro Contato:
- A equipe de integração da Layers agendará uma conversa inicial para avaliação de negócios e entendimento técnico.
2. Liberação de Acesso:
Resposta ao Formulário:
- A equipe de integração fornecerá um formulário para criar o ambiente de desenvolvimento.
Liberação do Ambiente de Integração:
- A Layers disponibilizará acesso ao ambiente Layers, identificador e chaves para a integração.
3. Desenvolvimento da Integração:
Rota de Conexão:
- A rota de conexão vincula o cliente na Layers e no parceiro, respeitando métodos de autenticação existentes ou definidos em acordo com a Layers.
Rota de Check:
- Primeira rota para verificar a operacionalidade do sistema integrado antes de iniciar a integração. Leia mais sobre como implementar a rota de
checar status da integração .
Rotas das Entidades:
Desenvolva rotas de acordo com o método de importação escolhido (Total ou Incremental).
Sincronização Total:
×Na sincronização total, a Layers faz cinco requisições para o app provedor. Primeiro, a Layers chama a rota de check para verificar se o app está disponível para sincronizar. Uma vez que o app responde com status 200, a Layers chama os quatro enpoints de dados para pegar informações de usuários, alunos, turmas e disciplinas.
Sincronização Incremental:
×Na sincronização do tipo incremental, a Layers faz a sincronização de check para verificar se o app está disponível para sincronizar. Uma vez que o app responde com status 200, a Layers faz a requisição de prepare para notificar que o app deve enviar os dados de sincronização nos próximos 30 minutos. O app provedor então deve processar os dados e enviar uma requisição para a layers para os dados de sincronização.
Preparar para sincronização - Enviar dados de sincronização
4. Checklist e Certificação:
Aplicação da Checklist de Homologação:
- A checklist automatizada verifica a aderência da integração, com base em testes de segurança, confiabilidade e experiência do cliente. O relatório é disponibilizado para ajustes no desenvolvimento.
Certificação:
- O programa de certificação garante que as aplicações integradas à Layers sejam verificadas e testadas, proporcionando uma experiência consistente e livre de problemas.
Implementação e Monitoramento:
- Dependendo da certificação, a integração será disponibilizada para clientes habilitarem a sincronização de dados entre as aplicações da Layers e do Parceiro.
Monitoramento:
- A Layers monitora a saúde da integração, aplica a checklist de homologação periodicamente e fornece acesso ao monitoramento de sincronização de dados para os clientes.
Suporte e Atendimento:
- Nosso time de suporte está treinado para atender tickets dos clientes sobre a sincronização de dados entre a aplicação e a Layers. A comunicação entre os suportes é transparente e ágil.
Este documento serve como um guia abrangente para implementação e manutenção da integração de dados na plataforma Layers. Caso haja dúvidas ou necessidade de mais detalhes, entre em contato com a equipe de suporte.