Todos os produtos
Search

Este produto

    API Gateway:Gerenciamento de autorização

    Central de documentação

    API Gateway:Gerenciamento de autorização

    Última atualização: Jun 27, 2026

    A autorização de API estabelece uma relação entre um aplicativo e uma API. O aplicativo representa a identidade usada para chamar a API e precisa de autorização prévia para essa chamada.

    Pré-requisitos

    O método de autenticação da API está definido como Alibaba Cloud App authentication.

    Aplicativos

    Um aplicativo funciona como a identidade usada para chamar uma API. Por padrão, cada aplicativo possui um par de chaves composto por AppKey e AppSecret. Envie o AppKey como parâmetro no cabeçalho da requisição e use o AppSecret para calcular a assinatura dessa requisição. Para mais detalhes sobre o cálculo e o envio da assinatura, consulte Usar autenticação digest para chamar uma API.

    • O par de chaves AppKey e AppSecret concede permissões totais ao aplicativo. Armazene-o com segurança. Se o par de chaves for comprometido, redefina-o no console do API Gateway.

    • Crie vários aplicativos e autorize-os a chamar diferentes APIs conforme suas necessidades de negócio. As autorizações são concedidas aos aplicativos, não à conta Alibaba Cloud.

    • No console do API Gateway, crie, modifique e exclua aplicativos, visualize detalhes, gerencie chaves e consulte as APIs autorizadas.

    • Adicione novos pares de AppKey e AppSecret a um aplicativo na página de detalhes. O novo par de chaves herda todas as permissões do aplicativo e pode ser excluído. O par de chaves padrão, gerado durante a criação do aplicativo, não pode ser removido.

    Criar um aplicativo

    1. Faça login no console do API Gateway. No painel de navegação à esquerda, escolha Call APIs > Apps e clique em Create App no canto superior direito.

    2. Na página Create App, insira um App Name e clique em Create.

    Nota

    Ao criar um aplicativo, defina tags, forneça informações personalizadas de AK e configure um extension field.

    • Configurações de tag: Use tags para organizar seus aplicativos.

    • Informações personalizadas de AK: Defina um AppKey e um AppCode personalizados durante a criação do aplicativo. Modifique o AppKey e o AppCode de um aplicativo em produção; as alterações entram em vigor imediatamente.

    • Extension field: Configure um campo de extensão para o aplicativo. O API Gateway envia esse campo ao serviço de backend como o parâmetro de sistema CaAppExtInfo.

      Importante

      Para instâncias dedicadas adquiridas antes de agosto de 2023, se o campo de extensão não entrar em vigor, envie um ticket para atualizar a versão da sua instância.

    Desativar um aplicativo

    1. Faça login no console do API Gateway. No painel de navegação à esquerda, escolha Call APIs > Apps.

    2. Clique no aplicativo desejado para acessar a página Application Details. Em seguida, clique em Disable App Authentication no canto superior direito.

      Nota

      Após a desativação, o aplicativo não poderá mais chamar as APIs autorizadas. Reative o aplicativo a qualquer momento para retomar as chamadas.

      Importante

      Para instâncias dedicadas adquiridas antes de julho de 2025, se este recurso não funcionar, envie um ticket para atualizar a versão da sua instância.

    Autorização de API

    A autorização consiste no processo de conceder permissão a um aplicativo para chamar uma API. Todo aplicativo precisa de autorização antes de chamar uma API.

    • Autorize diretamente seus próprios aplicativos a chamar suas APIs.

    • Autorize seus aplicativos a chamar APIs adquiridas no Alibaba Cloud Marketplace. Se você ainda não tiver um aplicativo, o Alibaba Cloud Marketplace criará um automaticamente e o autorizará durante a compra. Para mais informações, acesse o console do Alibaba Cloud Marketplace.

    • Para usar a API de um parceiro (de outra conta Alibaba Cloud) mediante acordo offline, crie um aplicativo e forneça o ID correspondente ao parceiro. Assim, ele poderá autorizar seu aplicativo buscando pelo ID informado.

    Procedimento

    1. Faça login no console do API Gateway. No painel de navegação à esquerda, escolha Manage APIs > APIs, localize a API desejada e, na coluna Actions, clique em image> Authorize.

    2. Na página de autorização, selecione um stage e um Authorization validity period. Escolha o aplicativo a ser autorizado em Choose apps for authorization. Para autorizar um aplicativo da sua própria conta, selecione My apps e clique em Search para carregar todos os aplicativos vinculados à sua conta.

      Para autorizar um aplicativo de outra conta, selecione App ID, insira o ID do aplicativo correspondente na caixa de texto e clique em Search.

      Importante

      Para instâncias dedicadas adquiridas antes de novembro de 2023, se um novo par de chaves adicionado não entrar em vigor, envie um ticket para atualizar a versão da sua instância. O par de chaves padrão, gerado na criação do aplicativo, não é afetado pela versão da instância.