Guia de permissões e endpoints da API Activesoft
Relacione os acessos do token às rotas da API e identifique dependências de permissões e parâmetros.
1
Como interpretar as permissões
Gere o token em [Administrativo > Configurações > Controle de acesso > Acesso via API]. As permissões disponíveis dependem do plano, do usuário e das funcionalidades liberadas para a instituição. Esta referência trata a API de terceiros do Activesoft, não a configuração da parceria isaac.
Acesso a dados cadastrais e detalhes de enturmação aparecem desde os planos de entrada. Endereços, parâmetros, boletins, notas, usuários e alocação professor/disciplina dependem dos planos que incluem esses recursos. Escrita, frequência, dados complementares, informações de boletos, ocorrências, diários e Ensino Superior pertencem aos planos que liberam esses acessos.
⚠️
2
Quais endpoints cada permissão libera
O prefixo das rotas é /api/v{version}/. Substitua a versão conforme a documentação disponibilizada à instituição.
GET /api/v{version}/lista_alunos/GET /api/v{version}/lista_responsaveis/GET /api/v{version}/lista_colaboradores/GET /api/v{version}/lista_coordenadores/GET /api/v{version}/lista_turmas/GET /api/v{version}/lista_cursos/GET /api/v{version}/lista_disciplina_turma/GET /api/v{version}/lista_planos_pagamento/GET /api/v{version}/enturmacao/GET /api/v{version}/lista_alunos_com_descontos/GET /api/v{version}/alocacao/
GET /api/v{version}/enturmacao_com_detalhes/GET /api/v{version}/lista_alunos_endereco/GET /api/v{version}/lista_responsaveis_endereco/
GET /api/v{version}/parametro/GET /api/v{version}/lista_unidades/
GET /api/v{version}/detalhe_boletim/ (Exige ?aluno_id=)GET /api/v{version}/aluno_notas/ (Exige ?aluno_id= E &turmas_ativas=true ou &turma_id=)GET /api/v{version}/lista_usuarios/ (Dados dos operadores do sistema ERP)GET /api/v{version}/lista_alocacao_professor_disciplina/ (Grade de horários/disciplinas por professor)Permissão de escrita: para marcar frequência, combine escrita e frequência. Não concede escrita irrestrita em todas as rotas cadastrais.POST /api/v{version}/correcao_prova/.GET /api/v{version}/listar_frequencia_aluno/ (Exige ?aluno_id=)POST /api/v{version}/marcar_frequencia_aluno/GET /api/v{version}/acesso/alunos/GET /api/v{version}/acesso/enturmacao/GET /api/v{version}/acesso/vinculo_aluno_responsavel_liberado/GET /api/v{version}/identificar_marcacao/{chave_pessoa}/
GET /api/v{version}/lista_alunos_dados_sensiveis/GET /api/v{version}/lista_responsaveis_dados_sensiveis/
GET /api/v{version}/financeiro/empresas/GET /api/v{version}/financeiro/forma_recebimento/GET /api/v{version}/financeiro/servicos/GET /api/v{version}/financeiro/calculo_multa_juros/POST /api/v{version}/financeiro/gerar_cobranca/
GET /api/v{version}/informacoes_boleto/ GET /api/v{version}/lista_aluno_curso_ensino_superior/GET /api/v{version}/lista_aluno_periodo/
GET /api/v{version}/lista_aluno_ocorrencia/ (Exige ?aluno_id=)GET /api/v{version}/diarios/ (Exige filtro na URL)GET /api/v{version}/diario_frequencia/ (Exige filtro na URL)3
Quais dependências conferir
- Endereço: marque simultaneamente acesso a dados cadastrais e acesso a dados de endereço.
- POST marcar_frequencia_aluno: exige os escopos frequência e escrita.
- POST correcao_prova: utiliza a permissão específica de alteração de notas.
- detalhe_boletim: informe aluno_id.
- aluno_notas: informe aluno_id e o recorte de turma exigido pela rota.
- lista_aluno_ocorrencia e listar_frequencia_aluno: informe aluno_id.
- diarios e diario_frequencia: informe os filtros exigidos na documentação.
- Rotinas de criação de cobrança: a disponibilidade deve ser conferida na tela; não presuma que informações para boleto e criação de boleto sejam a mesma permissão.
Migração é uma rotina de suporte e não deve ser usada como integração comum do parceiro.
4
Como interpretar códigos HTTP
Consulte os exemplos e parâmetros completos em Documentação da API Activesoft.
Comentários
0 comentário
Por favor, entre para comentar.