Como gerar um token para integrar parceiros à API Activesoft
Selecione o parceiro, defina as permissões e a validade e acesse a documentação da API.
Objetivo deste artigo: Selecione o parceiro, defina as permissões e a validade e acesse a documentação da API.
1
Como acessar a geração de token
- Acesse [Administrativo > Configurações > Controle de acesso > Acesso via API].
- Clique no campo [Parceiro] e digite o nome do parceiro que receberá o acesso. Se ele já estiver cadastrado, selecione o nome na lista.
- Para cadastrar um novo parceiro, digite o nome completo no mesmo campo e selecione [Cadastrar: nome informado], na lista de opções. Por exemplo, ao digitar Novo parceiro, selecione [Cadastrar: Novo parceiro]. O nome ficará selecionado para a geração do token.
2
Como escolher as permissões
Em [Permissões de acesso para este token], selecione os acessos necessários à integração. Consulte o ícone de informação ao lado de cada opção para entender o que ela permite. As opções disponíveis variam conforme o plano e o perfil de acesso.
Algumas operações precisam de mais de uma permissão. Para consultar endereços, selecione tanto a permissão de acesso a dados cadastrais quanto a de acesso a dados de endereço. Para registrar a frequência dos alunos, habilite registrar ou consultar frequência de alunos e realizar alteração em dados. A permissão de alterar notas dos alunos permite o envio de notas pela integração de correção de provas.
A permissão de carregar dados para migração é de uso exclusivo do suporte Activesoft. Para as demais integrações, peça ao parceiro que informe quais dados precisa consultar e quais operações precisa realizar. Selecione as permissões correspondentes, pois o acesso a dados acadêmicos, como notas e frequência, não libera automaticamente as operações financeiras, como consulta ou criação de cobranças.
3
Como definir a validade e concluir
- Em [Este token estará ativo até], informe a data até a qual o parceiro poderá utilizar o token. Se deixar o campo em branco, a validade padrão será de 10 anos.
- Leia [ver termo de consentimento]. Depois de conferir os termos e os acessos solicitados, marque [Eu concordo com os termos de uso para a informação fornecida].
- Clique em [Gerar token] para concluir a geração.
- Compartilhe o token com o parceiro autorizado e guarde-o conforme o controle de acesso da instituição.
4
Como consultar a documentação
Na mesma tela, clique em [Documentação da API] para consultar os métodos, os parâmetros e os exemplos das rotas disponíveis para integração.
O token permite acessar somente os dados e as operações autorizados nas permissões selecionadas. A presença de uma rota na documentação não significa que o parceiro tenha acesso a ela.
Comentários
0 comentário
Por favor, entre para comentar.