Chamada das APIs
Obtenção de APIs e documentação
Antes de chamar as APIs, obtenha as informações de solicitação do provedor da API, incluindo os parâmetros de nome de domínio de acesso, protocolo, método, caminho e solicitação.
Obtenha APIs da sua empresa ou de um parceiro.
Para APIs obtidas da Huawei Cloud, obtenha documentação na Central de ajuda.
As informações de autenticação a serem obtidas variam com o modo de autenticação da API.
- Autenticação de aplicação:
- Autenticação de assinatura: obtenha a chave e o segredo (ou AppKey e AppSecret do cliente) da aplicação autorizada para a API do provedor de API, bem como o SDK para chamar a API.
- Autenticação simples: obtenha o AppCode da aplicação autorizada para a API do provedor de API.
- Outros modos de autenticação: obtenha a chave e o segredo (ou AppKey e AppSecret do cliente) da aplicação autorizada para a API do provedor de API.
- Autenticação do IAM: a credencial da conta (token ou AK/SK obtido com a conta e a senha) obtida na plataforma de serviço em nuvem é usada para autenticação. Se o AK/SK for usado para autenticação, você também precisará obter o SDK do provedor da API para chamar a API.
- Autenticação personalizada: obtenha as informações de autenticação personalizadas a serem transportadas nos parâmetros de solicitação do provedor de API.
- Nenhum: nenhuma informação de autenticação é necessária.
Chamar uma API
Esta seção descreve somente a configuração do caminho da solicitação e dos parâmetros de autenticação. Para outros parâmetros, como tempo limite e SSL, configure-os conforme necessário. Para evitar perdas de serviço devido a parâmetros incorretos, configure-os consultando os padrões da indústria.
- Defina o caminho da solicitação.
Cenário
Configuração de parâmetros de solicitação
Chamar uma API com um nome de domínio
Chame uma API usando o nome de domínio de depuração alocado ao grupo de APIs ou um nome de domínio vinculado ao grupo. Não é necessária configuração adicional.
Chamar uma API no grupo DEFAULT com um endereço IP
Chame uma API no grupo DEFAULT com um endereço IP. Não é necessária configuração adicional.
Chamar uma API em um grupo personalizado com um endereço IP
- Para chamar APIs usando um endereço IP, verifique se o parâmetro app_route foi definido como on na página de guia Parâmetros do gateway.
- Para usar um endereço IP para chamar uma API que usa autenticação de aplicação em um grupo não-DEFAULT, adicione os parâmetros de cabeçalho X-HW-ID e X-HW-APPKEY e defina os valores de parâmetro para a chave e o segredo de uma aplicação autorizada para a API ou um AppKey e AppSecret do cliente.
- Para usar um endereço IP para chamar uma API que não usa autenticação de aplicação em um grupo que não é DEFAULT, adicione o parâmetro de cabeçalho host.
- Defina os parâmetros de autenticação.
Modo de autenticação
Configuração de parâmetros de solicitação
Autenticação de aplicação (com uma assinatura)
Use o SDK para assinar solicitações de API. Para obter detalhes, consulte Chamar APIs por meio de autenticação de aplicação.
Autenticação de aplicação (através de autenticação simples)
Adicione o parâmetro de cabeçalho X-Apig-AppCode e defina o valor do parâmetro para o AppCode obtido em Obtenção de APIs e documentação. Para obter detalhes, consulte Primeiros passos.
Autenticação de aplicação (com app_api_key)
- Para ativar a autenticação app_api_key, verifique se o parâmetro app_api_key foi definido como on na página de guia Parâmetros do gateway.
- Adicione o parâmetro apikey do cabeçalho ou da cadeia de consulta e defina o valor do parâmetro para a chave ou AppKey obtida em Obtenção de APIs e documentação.
Autenticação de aplicação (com app_secret)
- Na página de guia Parâmetros de um gateway, o parâmetro app_secret foi definido como on para ativar a autenticação app_secret e app_api_key como off para desativar a autenticação app_api_key.
- Adicione o parâmetro X-HW-ID do cabeçalho e defina o valor do parâmetro como a chave da aplicação autorizada para a API ou o AppKey do cliente.
- Adicione o parâmetro de cabeçalho X-HW-AppKey e defina o valor do parâmetro para o segredo ou AppSecret obtido em Obtenção de APIs e documentação.
Autenticação de aplicação (com app_basic)
- Para habilitar a autenticação app_basic, verifique se o parâmetro app_basic foi definido como on na página de guia Parâmetros do gateway.
- Adicione o parâmetro de cabeçalho Authorization e defina o valor do parâmetro como "Basic + base64 (appkey + : + appsecret)", em que appkey e appsecret são a chave e o segredo (ou AppKey e AppSecret) obtidos em Obtenção de APIs e documentação.
Autenticação de aplicação (com app_jwt)
- Para habilitar a autenticação app_jwt, verifique se o parâmetro app_jwt foi definido como on na página de guia Parâmetros do gateway.
- Adicione o parâmetro de cabeçalho Timestamp e defina o valor do parâmetro para o carimbo de data/hora Unix da hora atual.
- Adicione o parâmetro de cabeçalho Authorization e defina o valor do parâmetro como "sha256 (appkey + appsecret + timestamp)", no qual appkey e appsecret são a chave e segredo (ou AppKey e AppSecret) obtidos em Obtenção de APIs e documentação e carimbo de data/hora é o carimbo de data/hora Unix da hora atual.
Autenticação do IAM (com um token)
Obtenha um token da plataforma de nuvem e transporte o token em solicitações de API para autenticação. Para obter detalhes, consulte Autenticação de token.
Autenticação do IAM (com AK/SK)
Use um SDK para assinar solicitações de API. Para obter detalhes, consulte Autenticação de AK/SK.
Autenticação personalizada
Carregue informações de autenticação em parâmetros de solicitação de API para autenticação.
Nenhum
Chamar APIs sem autenticação.
