Guias Canvas (Portuguese - Brazil)Guia do Administrador IntegraçõesComo adiciono uma chave de API de desenvolvedor a uma conta?

Como adiciono uma chave de API de desenvolvedor a uma conta?

Como administrador, você pode criar chaves API de desenvolvedor para contas-raiz. Uma chave API de desenvolvedor é um código fornecido ao desenvolvedor de um aplicativo de terceiros que permite o acesso a certas informações e permissões dentro do Canvas. As chaves API do desenvolvedor podem ser usadas para criar integrações personalizadas com o Canvas e permitir que aplicativos de terceiros usem a autenticação do Canvas. A chave API do desenvolvedor usa OAuth2 para permitir que o aplicativo use Canvas para autenticação. Para obter mais informações sobre o OAuth2, consulte a documentação do Instructure API OAuth.

A chave API do desenvolvedor é enviada do aplicativo para o Canvas quando um usuário solicita acesso. O aplicativo pede ao usuário permissão para criar programaticamente um token de acesso à API. Quando o usuário autoriza o aplicativo, o aplicativo de terceiros terá o mesmo acesso às informações e permissões de conta que o usuário que concedeu o acesso. Para obter mais informações sobre os documentos do desenvolvedor, consulte a página Github da Instructure.

Escopo-chave

Chaves API de desenvolvedor incluem funcionalidade para escopo de chave como parte da adição de uma chave de desenvolvedor. O escopo de chave permite que você controle o acesso direto a endpoints de API específicos para ferramentas de terceiros.

Nota: Chaves do desenvolvedor é uma permissão da conta. Se não conseguir visualizar o link Chaves do desenvolvedor na Navegação da conta, esta permissão não foi habilitada para a sua conta do usuário.

Abrir Conta

Abrir Conta

Na Navegação Global (Global Navigation), clique no link Admin [1], depois clique no nome da conta [2].

Abrir chaves do desenvolvedor

Abrir chaves do desenvolvedor

Na Navegação da Conta, clique no link Chaves do desenvolvedor (Developer Keys).

Adicionar chave do desenvolvedor

Adicionar chave do desenvolvedor

Clique no botão Adicionar chave de desenvolvedor (Add Developer Key).

Adicionar chave API

Adicionar chave API

Clique na opção Adicionar chave API (Add API Key).

Inserir as configurações da chave

Inserir as configurações da chave

Insira as configurações para a chave API de desenvolvedor:

  • Nome da chave (Key Name) [1]: Normalmente, o nome do seu aplicativo ou empresa. Este campo será mostrado quando os usuários forem solicitados a aprovar o acesso à conta do Canvas em seu nome.
  • E-mail do proprietário (Owner Email) [2]: O e-mail da pessoa que possui a ferramenta de desenvolvedor.
  • Redirecionar URIs (Redirect URIs) [3]: Os domínios onde os tokens são solicitados. Esses URIs não são o URL do seu Canvas. Para evitar preocupações de navegador com conteúdo misturado, use HTTPS.
  • URI de redirecionamento (herdado) [Redirect URI (Legacy)] [4]: O URI para o redirecionamento de chave. Este campo permite que você defina o URI anterior para uma ferramenta. Eventualmente, este campo será removido.
  • Código do fornecedor (LTI 2) [Vendor Code (LTI 2)] [5]: Um código registrado exclusivo que identifica o fornecedor ou desenvolvedor da ferramenta de terceiros. Isso é especificamente para ferramentas e aplicativos LTI 2.
  • URL do ícone (Icon URL) [6]: O URL do ícone para sua ferramenta de desenvolvedor. Este URL é apresentado ao usuário para aprovar a autorização para sua ferramenta. Para evitar preocupações de navegador com conteúdo misturado, use HTTPS.
  • Notas (Notes) [7]: Qualquer observação sobre a chave do desenvolvedor, como o motivo de sua criação.
  • Grupo de teste apenas (Test Cluster Only) [8]: Cria uma chave de desenvolvedor que só pode ser usada no ambiente de teste Canvas.
  • Aplicar escopos (Enforce Scopes) [9]: Permite que você personalize o acesso à chave. Caso contrário, a chave terá acesso a todos os endpoints disponíveis para o usuário autorizador.

Salvar chave

Salvar chave

Clique no botão Salvar (Save).

Visualizar chave

Visualizar chave

Visualize a chave do desenvolvedor de sua conta.