Skip to main content

Building Blocks e APIs REST

Blackboard concede acesso público a um conjunto de APIs REST que permitem aos desenvolvedores desenvolver aplicativos personalizados que acessam o Blackboard. Para saber mais sobre nossos parceiros de integração, visite o Catálogo de aplicativos da Anthology.

Por que os APIs REST?

O uso de APIs REST permite que um desenvolvedor desenvolva aplicativos que são apenas vagamente acoplados ao servidor do Blackboard. Podem residir em qualquer lugar. Permitem que o servidor entregue as informações sem correr o risco de uma possível interferência.

Segurança com as APIs REST

As APIs REST podem operar sob uma variedade de modelos de segurança. Blackboard a autorização da API REST usa o OAuth 2.0 padrão do setor. Permite fazer solicitações com base em privilégios definidos pelo administrador do Blackboard. Além disso, os aplicativos podem utilizar uma variação de três fatores do protocolo. Essa abordagem autentica aplicativos como usuários específicos do Blackboard, sem compartilhar suas credenciais. Os usuários iniciam a sessão ara permitir que o aplicativo atue em seu nome. Em seguida, o aplicativo adquire apenas o mesmo nível de acesso do usuário.

Importante

Como prática recomendada, conceda aos usuários da integração os privilégios mínimos necessários para utilizar a ferramenta integrada – e não permissões completas de administrador do sistema.

O que você pode fazer com as APIs REST?

Você pode solicitar acesso às APIs REST do Blackboard por meio do Portal do desenvolvedor. Depois de registrar o aplicativo, geraremos uma chave e um segredo exclusivos para que você possa fazer chamadas e obter os dados necessários para integrar o aplicativo à plataforma. Aplicativos baseados em REST podem acessar, por exemplo:

  • avisos

  • cursos

  • conteúdo

  • anexos

  • exercícios

  • notas

Para obter uma lista completa de pontos de extremidade REST disponíveis para desenvolvedores, consulte a documentação da API REST da Anthology. Você também pode saber mais sobre a estrutura da API REST do Anthology e encontrar informações sobre as Primeiras etapas com a API REST.

Registrar uma integração REST em Blackboard

Blackboard é compatível com a integração de aplicativos externos criados utilizando APIs REST do Blackboard. Antes de utilizar uma integração com o Blackboard, o administrador deve registrá-la no Blackboard.

Antes de começar a registrar o aplicativo, você deve obter o Código do aplicativo. O desenvolvedor pode fornecer o código diretamente ao administrador ou anexá-lo à documentação de suporte do aplicativo.

  1. No Painel do Administrador, em Integrações, clique em Integração de APIs REST.

  2. Clique em Fazer integração.

  3. Em Código do aplicativo, digite o código do aplicativo fornecido ao registrar um aplicativo no Portal do desenvolvedor do Anthology.

  4. Ao lado de Usuário do Learn, clique em Navegação. Pesquise o usuário do Blackboard que a integração deve simular. Normalmente, uma integração atua como Administrador ou algum outro usuário cadastrado para gerenciamento de integração. O ideal é que o usuário tenha apenas as permissões necessárias para a integração funcionar corretamente

  5. Para a integração de terceiros, defina o Acesso do usuário final como Sim. Os usuários finais entrarão com seu próprio Código Blackboard para utilizar a integração. O acesso de cada usuário passa a se limitar às respectivas permissões. Se você definir o Acesso do usuário final como Não, a integração sempre terá acesso como se fosse o usuário do Blackboard indicado no formulário.

  6. Clique em Enviar para salvar as configurações.