Acesso à API
APIs disponíveis
| API | Finalidade | Escopo OAuth |
|---|---|---|
| API de Registros de Treinamento | Ler atribuições, resultados de conclusão, informações de grupos e o status opcional dos convites. | training.read |
| API de Usuários | Ler alunos com treinamento atribuído, incluindo as datas de cadastro, último acesso e última atribuição. | training.read |
| API de Grupos | Listar grupos no escopo do cliente, incluindo números de fornecedor e status de arquivamento. | training.read |
| API de Pacotes | Listar pacotes de treinamento e seus cursos. | training.read |
| API de Certificados | Listar certificados emitidos e baixar seus PDFs. | training.read |
| API de Atribuições | Atribuir alunos a um pacote em lotes. | assignments.write |
Acesso e permissões
As APIs de leitura ficam limitadas à organização ou ao grupo exibido na navegação de Acesso à API. O sistema externo não pode ampliar o escopo de leitura enviando outro identificador. As atribuições também exigem pacote e grupo permitidos, mas consulte o aviso sobre atribuições existentes antes de conceder acesso de escrita a um cliente de grupo.
- Administradores da organização, autores e administradores de autores podem criar clientes para a organização selecionada.
- Administradores de grupo podem criar clientes para um grupo que administram.
- Quando cada grupo paga sua própria assinatura, ele precisa ter uma conta paga ativa para usar a API.
O administrador que cria o cliente continua sendo seu proprietário. Se ele perder a permissão sobre a organização ou o grupo, o cliente deixa de funcionar. As credenciais do grupo também deixam de funcionar se o grupo perder a elegibilidade de acesso.
Os clientes de API são somente leitura por padrão. Para permitir atribuições, ative Atribuir usuários para o cliente em Clientes de API. Ao desativar essa opção, as atribuições são bloqueadas mesmo com tokens já emitidos.
Credenciais
Criar um cliente de API
- Abra Acesso à API para o escopo necessário:
- Para a organização atual, abra o menu da conta e selecione Acesso à API abaixo do nome da organização.
- Para um grupo, abra Meus Grupos, expanda o grupo e selecione Acesso à API.
- Selecione Criar Cliente de API.
- Informe um Nome descritivo para o sistema externo ou ambiente e selecione Criar Cliente de API.
- Copie o ID do Cliente e o Segredo do Cliente para o gerenciador de segredos do sistema externo antes de fechar a caixa de diálogo.
O segredo é exibido apenas uma vez. O e-LearningCourses armazena uma representação protegida e não pode mostrar o segredo original novamente. Se ele for perdido, regenere-o.
Gerenciar clientes de API
Crie um cliente separado para cada sistema externo e ambiente.
Ative Atribuir usuários apenas para clientes que precisem criar alunos e atribuir pacotes. A opção fica desativada por padrão.
- Regenerar Segredo cria um novo segredo e revoga imediatamente os tokens da credencial anterior. Atualize o sistema externo antes que ele solicite outro token.
- Revogar desativa permanentemente o cliente e revoga seus tokens atuais. Crie outro cliente se o acesso voltar a ser necessário.
- Último Uso indica a última emissão bem-sucedida de token, não cada solicitação à API.
Consulte Autenticação para trocar essas credenciais por um token de acesso.