Guias Canvas (Portuguese - Brazil)Guia do Administrador IntegraçõesComo habilito o escopo para uma chave de API de desenvolvedor em uma conta?

Como habilito o escopo para uma chave de API de desenvolvedor em uma conta?

Como parte da criação de novas chaves API de desenvolvedor ou da edição de chaves API de desenvolvedor existentes em sua conta, você pode personalizar o acesso que a chave API recebe. A aplicação de escopos permite que você controle o acesso direto e endpoints de API específicos para ferramentas de terceiros associadas à sua instituição.

Por padrão, a aplicação de escopo é desabilitada ao criar uma nova chave API de desenvolvedor, o que permite que tokens acessem todos os endpoints disponíveis para o usuário autorizador. No entanto, os escopos podem ser editados para uma chave API de desenvolvedor a qualquer momento e atualizar os tokens de acesso para o usuário autorizador de forma adequada.

Notas:

  • Gerenciar Chaves de Desenvolvedor é uma permissão de conta. Se você não pode gerenciar chaves de desenvolvedor, essa permissão não foi habilitada para sua função de usuário.
  • Chaves de Desenvolvedor não estão disponíveis em subcontas.

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).

Aplicar escopos

Aplicar escopos

Depois de preencher as informações da chave do desenvolvedor, clique no botão Aplicar escopos (Enforce Scopes).

Permitir parâmetros Include

Permitir parâmetros Include

Para permitir o uso de todos os parâmetros "includes" para esta chave, clique na caixa de seleção Permitir parâmetros de inclusão (Allow Include Parameters).

Os parâmetros "Inclui" podem conceder acesso a dados adicionais que não estão incluídos na tabela Endpoints.

Pesquisar endpoints

Pesquisar endpoints

Para pesquisar um endpoint específico, digite o nome do endpoint no campo Pesquisar endpoints (Search Endpoints) [1].

Para ver todos os endpoints disponíveis, role pela tabela Endpoints [2].

Selecionar endpoints somente leitura

Selecionar endpoints somente leitura

Para conceder acesso somente leitura (GET) à chave do desenvolvedor, marque a caixa de seleção Somente leitura (Read only). A tabela será atualizada automaticamente e selecionará todos os escopos que contêm endpoints somente leitura.

Selecionar endpoints individuais

Selecionar endpoints individuais

Você pode conceder acesso personalizado à chave API do desenvolvedor. Clique em qualquer nome de escopo para visualizar os endpoints disponíveis [1]. Selecione os endpoints desejados clicando na caixa de seleção ao lado do nome do endpoint [2]. A linha do nome do escopo será atualizada para mostrar o resumo do acesso ao endpoint coletivo selecionado [3].

Salvar chave

Salvar chave

Clique no botão Salvar (Save).