Manual Ábaris
Manual Ábaris
Manual Ábaris
  • 🔎Como podemos te ajudar?
  • ✅Vantagens de utilizar o Ábaris
  • ÁBARIS
    • Tarefas e Fluxos
      • 🛫Configurando o Workflow
        • Novo Workflow
        • Como desenhar processos no Workflow
          • Elementos disponíveis
        • Atributos
        • Configurações
        • Diagrama
        • Tipos de Documento
        • Grupos de Usuários
        • Excluir
        • Lixeira de Fluxos
      • ▶️Como iniciar uma tarefa (Novo Fluxo)
      • 🔎Monitorando o andamento das tarefas
        • Ações possíveis no Monitor de Tarefas
      • 🔨Executando Minhas Tarefas
      • 📊Monitorando os Fluxos
    • 🔗APIs e JSON
      • 🔡Utilizando o JSON na geração de documentos (SEAD)
        • 📔Testando o seu código
        • ⬆️Subindo um JSON no Ábaris
        • 🔣Fazendo login no Swagger
        • 🖼️Teste do XML gerado no fluxo
    • 👤Dia a dia
      • Encontrar documentos
        • Tag Restrição
      • Manejar os documentos
      • Inserir novos documentos no sistema
      • Importar e indexar documento
      • Temporalidade Documental
        • Pesquisar Temporalidades
        • Ações sob o Documento
          • Eliminar
          • Permanecer
          • Transferir
      • Minhas Aplicações
      • Minhas Solicitações
        • Pesquisar Solicitação
        • Visualizar Solicitação
        • Excluir Solicitação
        • Pendente Assinatura
        • Configurar Assinatura
        • Pendente Preenchimento
        • Rejeitados
        • Assinados
        • Vídeo Demonstração
      • Relatórios
      • Insights
      • Insights Processos
        • Pesquisar Processo
        • Fluxos do Processo
        • Matriz de Usuário por Tarefa com a quantidade como valor
        • Tempo Médio de Execução do Processo
        • Quantidade de Fluxos por Tarefa
        • Quantidade de Tarefas por Usuário/Grupo
        • Tempo Médio de Execução por Tarefa (horas)
        • Entrada de Fluxos por Período de Tempo
        • Encerramento de Fluxos por Período de Tempo
      • Consultar Empréstimo
      • Arquivo Físico
      • Aprovar Empréstimo
        • Pesquisar
        • Aprovar
        • Reprovar
      • Realizar Empréstimo
      • Devolver Empréstimo
      • Etiquetas
      • Page
    • 🖨️Uso do scanner (Capture)
      • Requisitos de hardware, software e permissões
      • Atualização do plugin do módulo Capture
      • Lista de Scanners Homologados
      • Primero acesso no ambiente de captura
        • Instalando o plugin do Capture
      • Opções da barra superior do Capture
      • Como digitalizar e importar documentos
        • Como editar os documentos digitalizados
        • Como organizar e categorizar os documentos
        • Como disponibilizar os documentos digitalizados no sistema
      • Plugin FileWatch
        • Instalação do Plugin FileWatch
        • Configuração do serviço de exportação dos arquivos
    • ⚙️Configurar
      • 🔧Administração
        • Como começar a usar o Ábaris na minha instituição
        • Como configurar uma licença
          • Como reservar licenças para um Grupo de Usuário
          • Como reservar licença para usuários
        • Como configurar as aplicações para uso
          • Editando uma aplicação
          • Como excluir uma aplicação
        • Como saber quais pessoas estão usando o sistema?
        • Verificar quais documentos estão em checkout
        • Como acessar o histórico de alterações nas configurações do sistema
        • Assinatura de documentos: configurando os Certificados Digitais
          • Editando um Certificado Digital
          • Apagando um Certificado Digital
      • 💻Ambiente
        • Armazenamento: como configurar onde os documentos serão salvos
          • Como acessar e editar as partições já existentes
          • Definindo os tipos de documento a serem armazenados no sistema
        • Protocolo LDAP
        • Configuração do acesso SAML
          • Como importar um certificado/ícone
        • Configurar padrão de relatório do sistema
      • 📄Documentos
        • Índices
        • Máscaras
        • Tipos de Documentos
        • Grupos de Documentos
        • Templates XML
        • Hierarquia de Documentos
        • Histórico de Documento
        • Temporalidade
        • Carimbos
        • Lixeira
        • Formulários Eletrônicos
      • 🧑Usuários
        • Departamento
        • Funções
        • Usuários
        • Grupos de Usuários
        • Grupo de Usuários
        • Política de Senha
      • 📑Arquivo físico
      • 🔌Serviços
        • File Watch
        • FTP
        • IMAP
        • Importações por Tag
        • SMTP
        • Monitores
        • Contabilizar Páginas
        • Indexação
        • Remoção de Documentos
        • Usuários Inativos
      • 🖨️Capture
        • Perfil de Digitalização
        • Lote
        • Exportação Personalizada
        • WebValidation
        • Processos
        • QR Code
    • 🔃Github WebValidation
  • RENOTARIZAÇÃO
    • Por que a Renotarização é importante?
    • Como vai funcionar a Renotarização no Ábaris
  • SeAD
    • Legislações gerais
    • Legislação sobre Diploma digital
    • O que é Acervo Acadêmico?
    • O processo de digitalização do Acervo
      • Digitalizar um documento
        • Processamento OCR
        • Validação de digitalizações e documentos
        • Sobre o PDF/A
        • O que posso fazer com meu acervo físico?
      • Assinatura digital
        • Certificado digital
        • A Portaria 315 e a Assinatura Digital
        • A Assinatura Digital tem prazo de validade? O que é Carimbo do Tempo?
          • Como ativar ou desativar meu Carimbo do Tempo?
  • LINKS IMPORTANTES
    • Central do cliente
    • Cursos online
    • Novidades
    • Sugestões de melhorias
    • Roadmap
    • Segurança
    • Privacidade
    • LGPD
Fornecido por GitBook
Nesta página
  1. ÁBARIS
  2. APIs e JSON

Utilizando o JSON na geração de documentos (SEAD)

Aqui você vai entender melhor sobre o uso do JSON no Ábaris

AnteriorAPIs e JSONPróximoTestando o seu código

Atualizado há 5 meses

A sua instituição recebe os fluxos todos prontos do nosso time de Projetos SEAD. Ou seja, você não precisa se preocupar com esses fluxos. Nosso time já deixa tudo certinho para você!

Swagger

Para entender sobre a geração do JSON, e até mesmo testá-lo, é importante que você tenha acesso aos endereços do Swagger, nossa ferramenta interativa de documentação e teste das APIs, onde você já tem uma descrição completa com os endpoints, métodos, parâmetros e respostas, além da possibilidade de testar seu código e alguns exemplos.

Exemplo de utilização

Os documentos mais utilizados pelas Secretarias Acadêmicas, por exemplo, são: currículo, histórico e diploma e a API que gera esses documentos é o endpoint "sample" que está no SEAD API 1.05.

Ao selecionar o "sample" do Diploma, você precisa configurar alguns parâmetros booleanos (true ou false), como se o diploma é digital ou não (NSF), se é uma segunda via e se é válido judicialmente. Após selecionar os parâmetros, ou um deles, basta clicar em EXECUTE e você verá o código JSON com informações randômicas. Dica: você pode baixar esses dados para o seu editor de códigos e fazer as substituições necessárias para ficar conforme a sua instituição.

Quanto aos diplomas, por exemplo, o MEC tem uma documentação padronizada para que esses parâmetros, variáveis e atributos, como chamamos no Ábaris, estejam corretos no momento em que o arquivo se converterá para XLS. .

Às SEADs um reforço: você deve estar por dentro da documentação disponibilizada pelo MEC, pois ela é requerida para uma geração de diploma válido, por exemplo.

🔗
🔡
SWAGGER DOCUMENT API 1.0
SWAGGER WORKFLOW API 1.0
SWAGGER SEAD API 1.05
Vale a pena acessar o arquivo XSD