Criar um App Services App
Nesta página
Visão geral
Você pode criar uma nova aplicação do App Services a partir da UI do App Services, CLI ou API de administração.
Um aplicativo Services App é uma instância de backend gerenciada que contém os serviços da seu aplicativo. Cada aplicativo pertence a um projeto específico do Atlas.
Para criar um aplicativo em um projeto, você deve estar conectado ao MongoDB Atlas e ter permissões de proprietário do projeto .
Antes de começar
Você precisará do seguinte para criar um App no Atlas UI:
Uma conta do MongoDB Atlas com permissões de Proprietário do Projeto. Para saber como criar uma conta gratuita, consulte Comece a usar o Atlas .
Você precisará do seguinte para criar um aplicativo no CLI:
Uma conta do MongoDB Atlas com permissões de Proprietário do Projeto. Para saber como criar uma conta gratuita, consulte Comece a usar o Atlas .
Uma admin API do MongoDB Atlas par de chaves pública/privada. A chave da API deve ter permissões do Proprietário do projeto para trabalhar com o App Services Admin API.
Uma cópia da CLI do App Services instalada e adicionada ao seu sistema local
PATH
. Para saber como, consulte Como instalar CLI do App Services.
Você precisará do seguinte para criar um aplicativo com a API de administrador:
Uma conta do MongoDB Atlas com permissões de Proprietário do Projeto. Para saber como criar uma conta gratuita, consulte Comece a usar o Atlas .
Uma admin API do MongoDB Atlas par de chaves pública/privada. A chave da API deve ter permissões do Proprietário do projeto para trabalhar com o App Services Admin API.
Procedimento
Escolha um Tipo de App
Você pode criar uma nova aplicação em branco ou iniciar a partir de um modelo que tem alguns serviços pré-configurados para você. Algumas aplicações de modelo também vêm com aplicações de cliente correspondentes.
Para saber mais, consulte Aplicativos de Modelo.
Se o projeto não tiver Apps, você será solicitado para criar um novo App a partir de um modelo ou para começar do zero.
Caso contrário, você pode escolher entre dois botões de criação no canto superior direito da aba App Services:
Para criar um aplicativo em branco, clique no botão Create a New App .
Para usar um modelo, clique em Create App from Template e selecione um modelo no menu suspenso.
Definir Configurações do App
A UI solicita que você defina as seguintes configurações:
O Nome do Aplicativo. O nome do seu App é público e incluído na ID do App utilizado pelos clientes.
Observação
Limitações de nome da aplicação
Os nomes das aplicações devem ter entre 1 e 32 caracteres e podem conter apenas letras, números, sublinhados e hifens ASCII.
Uma fonte de dados vinculada. Este é um Atlas cluster que a aplicação pode acessar. Se o projeto não tiver clusters, você poderá fazer com que o App Services crie um para você automaticamente.
Observação
MongoDB versão 5.0 ou superior necessária
O Atlas Device Sync requer um Atlas cluster executando o MongoDB versão 5.0 ou posterior. Ao configurar seu cluster, selecione a versão no menu suspenso em Additional Settings.
Você também pode definir as seguintes configurações opcionais em Advanced Configuration:
A Região do aplicativo que determina onde sua aplicação é executada e onde seus metadados são armazenados. Para saber mais, consulte Modelos e regiões de sistema.
O Ambiente do aplicativo que determina quais valores de ambiente utilizar. Para saber mais, consulte Configurar um ambiente de aplicativo.
Execute o comando de criação de aplicativo
A CLI pode criar um aplicativo e copiar seus arquivos de configuração para um diretório local com um único comando. O comando solicita que você especifique o nome do aplicativo e o projeto Atlas que deve conter o aplicativo. Você pode configurar o comando com bandeiras ou interativamente.
appservices apps create
O comando também oferece suporte a sinalizadores adicionais que você pode incluir opcionalmente para personalizar seu aplicativo. A tabela a seguir lista sinalizadores comuns que você pode usar:
| Escolha um modelo de aplicativo para começar. Se você não especificar um modelo, o comando criará um aplicativo em branco. Para obter uma lista de todos os aplicativos de modelo, consulte Aplicativos de modelo disponíveis. |
| |
| Define a região de implantação do aplicativo. Para obter uma lista de regiões disponíveis, consulte Regiões de implantação na nuvem. |
|
Veja também:
Para obter mais detalhes e sinalizações adicionais, consulte a documentação do CLI para o comando de criação.
Obter um token de acesso à API de administrador
Chame o endpoint de autenticação do usuário administrador com seu par de chaves da API do MongoDB Atlas:
curl -X POST \ https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -d '{ "username": "<Public API Key>", "apiKey": "<Private API Key>" }'
Se a autenticação for bem-sucedida, o corpo da resposta conterá um objeto JSON com um valor access_token
:
{ "access_token": "<access_token>", "refresh_token": "<refresh_token>", "user_id": "<user_id>", "device_id": "<device_id>" }
O access_token
concede acesso à App Services Admin API. Você deve incluí-lo como um token do portador no cabeçalho Authorization
para todas as solicitações de API Admin.
Veja também:
Criar um novo aplicativo
Você pode criar um novo aplicativo por meio do endpoint Criar um aplicativo .
Sua solicitação deve incluir:
Um
Authorization
cabeçalho com seu token de acesso à API Admin como um token do portador.Um
name
para o novo aplicativo
curl -X POST \ https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps \ --header 'Authorization: Bearer <access_token>' \ --data '{ "name": "<App Name>" }'
Se quiser criar um aplicativo a partir de um modelo, você também deverá incluir o seguinte no corpo da solicitação:
O campo
template_id
com um dos aplicativos de modelo disponíveis. Para obter uma lista de todos os aplicativos de modelo, consulte Aplicativos de modelo disponíveis.O campo
data_source
com informações sobre um Atlas cluster existente.curl -X POST \ https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps \ -H 'Authorization: Bearer <access_token>' \ -d '{ "name": "<App Name>", "template_id": "<Template App Id>", "data_source": { "name": "mongodb-atlas", "type": "mongodb-atlas", "config": { "clusterName": "<Atlas Cluster Name>" } } }'
Se a sua aplicação for criada com sucesso, a API retornará uma resposta de 201
com informações sobre sua nova aplicação.