Mobile Platform as a Service:Grupos de API

Um grupo de API gerencia APIs. Esse grupo pode representar o nome de um sistema específico, o nome de um módulo ou um identificador abstrato.

Atualmente, o Mobile Gateway oferece suporte aos seguintes tipos de grupos de API:

• HTTP: Grupo para serviços HTTP RESTful. Esses serviços permitem a invocação entre diferentes Virtual Private Clouds (VPCs).

• MPC: Grupo para serviços baseados no framework RPC proprietário do mPaaS. Também permite a invocação de serviços entre VPCs.

Criar um grupo

Antes de criar um grupo de API MPC, registre o serviço de API no registro especificado. Para mais informações, consulte Registrar um serviço de API MPC.

Faça login no console do mPaaS e acesse a página Mobile Gateway no painel de navegação à esquerda. Em seguida, crie os tipos de grupos de API conforme necessário.

• Criar um grupo de API HTTP

• Criar um grupo de API MPC

Criar um grupo de API HTTP

Para criar um grupo de API HTTP, siga estas etapas:

1. Clique em API Group para abrir a página de lista de grupos de API.

2. Clique em Create API Group. Na caixa de diálogo exibida, configure os parâmetros a seguir.

   • Group Type: Selecione HTTP.

   • API Group: Obrigatório. Insira o nome em inglês do serviço de backend.

   • Cross-VPC HTTP: Define se a invocação de serviços entre VPCs é permitida. Ao ativar essa opção, você possibilita a invocação de serviços em diferentes VPCs. Esse recurso foi projetado para cenários em que o Mobile Gateway Service (MGS) e seu serviço estão implantados em VPCs distintas e exigem o uso do MGS para invocar serviços de backend entre essas VPCs.

     Nota

     O recurso de HTTP entre VPCs está disponível apenas na região Shanghai Finance.

     Para ativar o recurso de invocação HTTP entre VPCs, configure os seguintes parâmetros:

     • Support HTTPS: O MGS pode encaminhar solicitações HTTPS usando listeners HTTPS do Server Load Balancer (SLB), garantindo criptografia de dados em trânsito. Esse recurso vem ativado por padrão. Caso não precise usar um nome de domínio HTTPS, selecione No.

     • HTTPS Domain Name: Este parâmetro é obrigatório apenas se você ativar o suporte a HTTPS. O valor deve corresponder ao nome de domínio do certificado anexado à instância do SLB.

     • VPC ID: O ID da VPC onde está localizada a instância do Elastic Compute Service (ECS) usada na implantação do serviço ou a VPC à qual a instância do SLB pertence.

     • Instance IP or Address: O endereço IP privado principal da instância do ECS usada na implantação do serviço ou o endereço IP da instância do SLB.

     • Port Number: O número da porta do serviço.

       Importante

       • O MGS não aceita certificados autoassinados. Ao utilizar HTTPS entre VPCs, use um nome de domínio com certificado assinado por uma CA. Caso contrário, a resolução do nome de domínio falhará.

       • Se você usar apenas uma instância do ECS para configurar o serviço de backend, abra as portas necessárias no grupo de segurança dessa instância para evitar que políticas de segurança bloqueiem as solicitações. Para obter informações sobre portas e endereços IP necessários, envie um ticket para entrar em contato com o suporte técnico.

       • Caso utilize exclusivamente uma instância do ECS para o serviço de backend, libere as portas necessárias no grupo de segurança da instância para evitar o bloqueio de solicitações por políticas de segurança. Para obter detalhes sobre portas e IPs, envie um ticket e contate a central de ajuda.

       • O acesso entre VPCs funciona somente dentro da mesma região. Por exemplo, um serviço implantado na região de Hangzhou não consegue invocar um serviço na região de Xangai. Além disso, zonas financeiras e não financeiras na mesma cidade são tratadas como regiões distintas. Assim, a região Hangzhou Finance e a região não financeira de Hangzhou constituem duas regiões diferentes.

       • Ao empregar instâncias de SLB e ECS simultaneamente para o serviço de backend, certifique-se de que ambas estejam na mesma VPC.

   • Service Endpoint: A URL HTTP ou HTTPS do serviço de backend. Este parâmetro torna-se obrigatório quando o recurso de HTTP entre VPCs está desativado.

   • Timeout: Opcional. Tempo limite para solicitações enviadas ao serviço de backend. Unidade: milissegundos. O valor padrão é 3000 ms.

3. Após configurar os parâmetros, clique em OK para criar o grupo.

Criar um grupo de API MPC

Para criar um grupo de API MPC, siga estas etapas:

1. Clique em API Group para acessar a lista de grupos de API.

2. Clique em Create API Group. Na caixa de diálogo exibida, configure os parâmetros a seguir.

   • Group Type: Selecione MPC.

   • API Group: Obrigatório. Insira o nome em inglês do serviço de backend. O nome do grupo de API deve ser idêntico ao nome do aplicativo do serviço de API registrado.

   • Timeout: Opcional. Tempo limite para solicitações enviadas ao serviço de backend. Unidade: milissegundos. O valor padrão é 3000 ms.

   • Project Name: Utiliza automaticamente o nome do projeto do ambiente atual como valor padrão.

3. Após configurar os parâmetros, clique em OK para criar o grupo.

Configurar grupos

Configure o grupo de API de acordo com o seu tipo.

Configurar um grupo de API HTTP

Na lista de grupos de API, localize o grupo de API HTTP desejado. Na coluna Operations, clique em Details para abrir a página de detalhes. No canto superior direito dessa página, clique em Modify. Configure os seguintes parâmetros para um grupo de API HTTP:

• Service Endpoint: URL do serviço HTTP de backend.

• Timeout: Unidade: milissegundos. O valor padrão é 3000 ms.

• Verify Signature: Ative esta opção caso o serviço de backend precise autenticar a identidade do chamador. Para mais detalhes sobre autenticação, consulte Verificação de assinatura de backend. Após ativar a verificação de assinatura, configure estes parâmetros:

  • Signature Algorithm: Algoritmo usado para gerar a assinatura. O Mobile Gateway do mPaaS na nuvem pública oferece suporte aos algoritmos MD5, RSA, SM2 e SM3.

  • Key: Chave usada na verificação da assinatura do backend. Você pode personalizar essa chave.

  • Key Content: Valor da chave usada para validar a assinatura do backend.

    • Se o algoritmo de assinatura for MD5, personalize o conteúdo da chave.

    • Se o algoritmo de assinatura for RSA, o valor corresponderá à chave pública do Mobile Gateway.

    • Se o algoritmo de assinatura for SM2 ou SM3, personalize o conteúdo da chave. Para saber como gerar uma chave, consulte Métodos de geração de chaves.

Configurar um grupo MPC

Na lista de grupos de API, localize o grupo de API MPC desejado. Na coluna Operations, clique em Details para abrir a página de detalhes. No canto superior direito dessa página, clique em Modify. Configure os seguintes parâmetros para um grupo de API MPC:

• Project Name: Nome do projeto do locatário associado ao grupo. O sistema recupera esse valor automaticamente e não permite modificação.

• Timeout: Unidade: milissegundos. O valor padrão é 3000 ms.