Ao criar novas chaves de API de desenvolvedor ou editar chaves de API de desenvolvedor existentes em sua conta, você pode personalizar o acesso que a chave de API recebe. A imposição de escopos permite controlar o acesso direto e os endpoints de API específicos para ferramentas de terceiros associadas à sua instituição.
Por padrão, a imposição de escopo está habilitada ao criar uma nova chave de API de desenvolvedor. Se estiver desabilitada, os tokens terão acesso a todos os endpoints disponíveis para o usuário que autorizou a operação.
Notas:
- Gerenciar chaves de desenvolvedor é uma permissão da conta. Se você não consegue gerenciar chaves de desenvolvedor, essa permissão não foi habilitada para sua função de usuário.
- As chaves de desenvolvedor não estão disponíveis em subcontas.
Abrir conta
Na Navegação Global, clique no link Admin [1] e, em seguida, clique no nome da conta [2].
Abra as chaves de desenvolvedor
Na Navegação da Conta, clique no link Chaves de Desenvolvedor .
Adicionar chave de desenvolvedor
Clique no botão Adicionar chave de desenvolvedor .
Adicionar chave de API
Clique na opção Adicionar chave de API .
Impor Escopos
Por padrão, a opção Impor Escopos está ativada [1]. Se estiver desativada, uma mensagem de aviso aparece [2].
Permitir inclusão de parâmetros
Para permitir o uso de todos os parâmetros de inclusão para esta chave, clique na caixa de seleção Permitir parâmetros de inclusão .
Os parâmetros incluídos podem conceder acesso a dados adicionais que não estão incluídos na tabela Endpoints.
Pontos finais de pesquisa
Para pesquisar um ponto de extremidade ou cabeçalho de seção específico, digite o nome do ponto de extremidade no campo Pesquisar pontos de extremidade [1].
Para ver todos os pontos de extremidade disponíveis, percorra a tabela de pontos de extremidade [2].
Selecionar endpoints somente leitura
Para conceder acesso somente leitura (GET) à chave de desenvolvedor, clique na caixa de seleção "Somente leitura ". A tabela será atualizada automaticamente e selecionará todos os escopos que contêm endpoints somente leitura.
Selecionar pontos finais individuais
Você pode conceder acesso personalizado à chave da 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 coletivo aos endpoints selecionados [3].
Salvar chave
Clique no botão Salvar .
