Documentação da API
Escopos
Cada chave carrega uma lista de escopos: o que ela pode fazer. O aplicativo pede os escopos na autorização (scope=account:read catalog:read), e a tela do HotLearn mostra à pessoa, em frases simples, o que está sendo liberado.
- Peça só o que vai usar. Quanto menos escopos, mais fácil a pessoa autorizar.
- Cada aplicativo cadastrado tem a lista de escopos que pode pedir. Um escopo fora dessa lista é ignorado.
- Chamada sem o escopo da rota recebe
403comcode=insufficient_scopee a lista do que faltou emscopes. - Para ganhar um escopo novo, o aplicativo pede a autorização de novo com a lista completa.
Lista de escopos
A coluna "Vale em" diz em que tipo de chave cada escopo pode ser usado.
| Escopo | Libera | Vale em |
|---|---|---|
catalog:public |
Ver a vitrine pública do acervo, sem conta (chave de aplicativo). | chave de aplicativo, sem conta |
account:read |
Ver a conta, o nome e o e-mail de quem autorizou, o plano, a situação da assinatura e o saldo de créditos. | aplicativo autorizado · chave pessoal |
catalog:read |
Ver o acervo, os produtos adquiridos e as criações da conta. | aplicativo autorizado · chave pessoal |
acquisitions:read |
Ver o histórico de aquisições. | aplicativo autorizado · chave pessoal |
acquisitions:write |
Adquirir produtos com os créditos da conta. | aplicativo autorizado · chave pessoal |
materials:read |
Ler e baixar os materiais da conta (a versão personalizada, quando existe). | aplicativo autorizado · chave pessoal |
publications:read |
Ver as publicações registradas pelo aplicativo. | aplicativo autorizado · chave pessoal |
publications:write |
Registrar o que foi criado fora a partir dos materiais. | aplicativo autorizado |
connection:write |
Atualizar os dados da própria conexão (nome, endereço, link e ações). | aplicativo autorizado |
login_links:write |
Gerar link para abrir o HotLearn já logado (só para membros da conta). | aplicativo autorizado |