Documentação da API do App Center

Especificação OpenAPI do App Center (Swagger)

O App Center expõe um conjunto completo de pontos de extremidade de API. Você pode explorar a API do App Center por meio da Especificação OpenAPI do App Center.

A especificação OpenAPI do App Center permite que você se autentique usando seu token de API. Depois de autenticado, você pode chamar as APIs do App Center para saber mais sobre a API e ver quais dados ela retorna.

Tipos de tokens: tokens de usuário e tokens de aplicativo

O App Center expõe dois tipos de tokens de API: tokens de usuário e tokens de aplicativo.

Os tokens de API de usuário têm os mesmos direitos que você tem como um usuário do App Center. Os tokens de API do usuário funcionam em todas as organizações e aplicativos aos quais você está associado.

Os tokens da API do aplicativo têm direitos de Gerente ou Visualizador, mas em apenas um aplicativo.

Cada conta do App Center pode criar até 5000 tokens de API.

Criando um token de API de aplicativo do App Center

1. Navegue e https://appcenter.ms inicie sessão com as credenciais da sua conta.

2. Selecione o aplicativo para o qual você deseja criar um token de API.

3. No lado esquerdo, escolha Configurações.

4. No painel central, selecione App API Tokens na lista de menus.

5. No canto superior direito, clique em Novo token de API.

6. No campo de texto, insira um nome descritivo para seu token.

7. Selecione o tipo de acesso para o token da API do aplicativo:

   Acesso Total: Um token de API de aplicativo de acesso total tem o equivalente às permissões do Gerenciador para esse aplicativo. Somente os gerentes podem criar tokens de API de aplicação de acesso total.

   Somente leitura: Um token de API de aplicativo somente leitura tem o equivalente às permissões de acesso do Visualizador para esse aplicativo. Gerentes e desenvolvedores podem criar tokens de API de aplicativo somente leitura.

8. Na parte inferior do painel, clique em Adicionar novo token de API.

9. Um pop-up será aberto com o token da API do aplicativo. Copie e armazene-o em um local seguro para uso posterior. Por motivos de segurança, não é possível ver ou gerar o mesmo token novamente depois de clicar no botão Fechar .

10. Clique no botão Fechar .

Criando um token de API de usuário do App Center

1. Navegue e https://appcenter.ms inicie sessão com as credenciais da sua conta.

2. No canto superior direito do portal do App Center, clique no avatar da sua conta e selecione Configurações da conta.

3. No painel central, selecione User API Tokens na lista de menus.

4. No canto superior direito, clique em Novo token de API.

5. No campo de texto, insira um nome descritivo para seu token.

6. Selecione o tipo de acesso para seu token de API de usuário:

   Acesso Total: Um token de API de usuário de acesso total tem todas as permissões que você tem para a conta / organização atual. Por exemplo, se você não tiver permissões de gerente ou desenvolvedor para um aplicativo, o usuário não poderá executar um teste, mesmo que você esteja usando um token de API de usuário de acesso total.

   Somente leitura: Um token de API de usuário somente leitura tem permissão de acesso do Visualizador para a conta / organização atual. Por exemplo, com um token de API de utilizador em modo apenas de leitura, pode aceder a dados de crashes, analíticas, e obter informações básicas da aplicação. Os tokens de API de usuário somente leitura não podem alterar as configurações do aplicativo, criar uma configuração de exportação, etc.

7. Na parte inferior do painel, clique em Adicionar novo token de API.

8. Um pop-up será aberto com seu token de API de usuário. Copie e armazene-o em um local seguro para uso posterior. Por motivos de segurança, não é possível ver ou gerar o mesmo token novamente depois de clicar no botão Fechar .

9. Clique no botão Fechar .

Usando um token de API em uma solicitação de API

Ao enviar solicitações de API para o App Center a partir de um aplicativo, você deve incluir o token de API no cabeçalho de cada solicitação enviada ao App Center.

Passe o token da API na propriedade header da X-API-Token solicitação.

Encontre o nome do aplicativo do App Center e o nome do proprietário

Algumas das funções de API e solicitações de CLI do App Center exigem um nome de aplicativo ou nome de proprietário como parâmetros.

Por exemplo, a chamada de API para remover o usuário do aplicativo requer ambos: DELETE /v0.1/apps/{owner_name}/{app_name}/users/{user_email}.

Você pode encontrar o nome do aplicativo e o nome do proprietário em uma URL do App Center ou usando a CLI do App Center.

Localizar owner_name e app_name a partir de um URL do App Center

1. Navegue até https://appcenter.ms.
2. Navegue até seu aplicativo.
3. Quando você olha para o URL do seu aplicativo, ele está no formato https://appcenter.ms/users/{owner-name}/apps/{app-name}.

O proprietário pode ser um usuário ou uma organização. Por exemplo:

Encontre owner_name e app_name na CLI do App Center

Se você ainda não instalou a CLI do App Center, as instruções de instalação e uso podem ser encontradas na documentação da CLI do App Center.

Uma vez instalado, recupere a lista de aplicativos que você tem acesso executando:

appcenter apps list

A CLI do App Center exibirá uma lista de aplicativos, com o formato {owner-name}/{app-name}.

Consulte a documentação da CLI do App Center para obter uma lista completa das funções de linha de comando.

Usando um token de API com a especificação OpenAPI do App Center

A Especificação OpenAPI do App Center lida com a autenticação de API para você, para que você não precise colar o token da API em cabeçalhos para suas solicitações. Para testar as APIs do App Center com seu token de API:

1. Navegue até a especificação OpenAPI do App Center para explorar nossas APIs.

2. No canto superior direito, clique no botão Autorizar .

3. Na seção APIToken , cole o token da API em Valor e clique em Autorizar.

   

4. Se aparecer "Autorizado" e um botão "Terminar sessão", a autorização foi bem-sucedida. No canto superior direito do pop-up, clique no "X" para sair do pop-up.

Fazendo sua primeira chamada de API usando OpenAPI (Swagger)

Esta seção mostra como usar a página OpenAPI do App Center usando a chamada GET /v0.1/userde API . Esta chamada de API retorna os dados de perfil do usuário.

1. Crie um token de API seguindo as instruções acima.
2. Autorize a página Especificação da OpenAPI a usar seu token de API seguindo as instruções na seção anterior.
3. Em Conta, clique em GET /v0.1/user.
4. No canto esquerdo, clique no botão Experimentar .
5. Clique no botão Executar na seção Parâmetros .
6. Fantástico! Agora você pode ver a resposta na seção Respostas .

Revogando um token de API

Caso um token de API seja vazado, você deve revogá-lo imediatamente para impedir o acesso não autorizado à sua conta do App Center.

Revogando um token de API do usuário

1. Navegue até https://appcenter.ms.
2. No canto superior direito do portal do App Center, clique no avatar da sua conta e selecione Configurações da conta.
3. No painel central, selecione User API Tokens no menu.
4. Marque a caixa ao lado do token que você deseja revogar e clique no botão Excluir no canto superior direito.

Revogando um token da API do aplicativo

1. Navegue até https://appcenter.ms.
2. Selecione o aplicativo para o qual você deseja revogar um token de API.
3. No lado esquerdo, escolha Configurações.
4. No painel do meio, selecione App API Tokens a partir do menu.
5. Marque a caixa ao lado do token que você deseja revogar e clique no botão Excluir no canto superior direito.