Use os kits de desenvolvimento de software (SDKs) gerados automaticamente pelo API Gateway para chamar APIs publicadas do seu sistema empresarial, sem implementar a lógica de assinatura manualmente.
Antes de começar
Os SDKs gerados automaticamente incluem uma implementação de assinatura integrada, o que elimina a necessidade de calcular assinaturas manualmente. Para implementar a autenticação por assinatura manualmente, consulte Instruções de assinatura no lado do cliente.
Conclua as etapas em Criar uma API com um serviço de backend HTTP antes de prosseguir. A API deve atender aos seguintes requisitos para que um SDK possa chamá-la:
O método de autenticação de segurança está definido como Alibaba Cloud App.
Sua aplicação tem autorização para chamar a API.
A API está publicada em um ambiente online.
1. Baixe um SDK
O console oferece dois caminhos para download, conforme você deseje um SDK com escopo de aplicação ou de grupo:
Por aplicação: No painel de navegação à esquerda, escolha e clique em Authorized APIs. Na seção Auto-generated SDKs/Documents for Authorized APIs, baixe o SDK da sua aplicação. Linguagens com suporte a geração automática: Objective-C, Android e Java. Exemplos de chamada para outras linguagens estão disponíveis na parte inferior da página.
Por grupo de APIs: No painel de navegação à esquerda, escolha e clique em Group APIs. Na seção Auto-generated SDKs/Documents, baixe o SDK do grupo de APIs. Linguagens com suporte a geração automática: Objective-C, Android, Java, Go e TypeScript.
2. Use o SDK para chamar uma API
O pacote do SDK descompactado contém a seguinte estrutura de diretórios:
-
Pasta sdk: arquivos source do SDK Java organizados por região e grupo.
* sdk/{{regionId}}: pasta do SDK Java para todas as operações de API em cada grupo.
* HttpApiClient{{group}}.java: métodos do cliente para operações de API que usam o canal HTTP.
* HttpsApiClient{{group}}.java: métodos do cliente para operações de API que usam o canal HTTPS.
* WebSocketApiClient{{group}}.java: métodos do cliente para operações de API que usam o canal WebSocket.
* Demo{{group}}.java: exemplos executáveis de chamada para todas as operações de API do grupo.
-
Pasta doc/{{regionId}}: documentação de referência da API.
* ApiDocument_{{group}}.md: referência da API correspondente ao grupo.
-
Pasta lib: dependências principais do SDK.
* sdk-core-java-1.1.5.jar: pacote principal do SDK. Obrigatório.
* sdk-core-java-1.1.5-sources.jar: código-fonte do pacote principal.
* sdk-core-java-1.1.5-javadoc.jar: Javadoc do pacote principal.
Readme.md: guia do usuário do SDK com instruções detalhadas de integração.
LICENSE: licença de direitos autorais.
Siga as instruções do arquivo Readme.md para integrar o SDK à sua aplicação e chamar APIs.
AppKey e AppSecret são as credenciais que o gateway usa para autenticar solicitações. Criptografe esses valores antes de implantá-los no lado do cliente.
3. Solução de problemas
Se uma chamada falhar, obtenha o ID da solicitação no cabeçalho da resposta para identificar o problema. Para etapas de diagnóstico, consulte Depuração de API e solução de problemas自助.
