Documentação App Center API do App Center

App Center Especificação openAPI (Swagger)

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

A App Center openAPI permite autenticar usando seu token de API. Depois de autenticado, você pode chamar App Center APIs para saber mais sobre a API e ver quais dados ela retorna.

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

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

Os tokens de API do usuário têm os mesmos direitos que você faz 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 de API do aplicativo têm direitos de Gerenciador ou Visualizador, mas dentro de apenas um aplicativo.

Cada App Center pode criar até 5.000 tokens de API.

Dica

É recomendável criar e usar tokens de API do aplicativo para limitar o escopo de autorização a apenas um aplicativo por vez (e limitar o risco se um token for exposto). Se você precisar automatizar algo além de um aplicativo, como trabalhar com organizações ou grupos de distribuição compartilhados, deverá criar um token de API de Usuário.

Aviso

Não inserir tokens de API no código-fonte. Os tokens de API devem ser tratados como segredos e armazenados com segurança.

Aviso

Uma solicitação deve conter um corpo de conteúdo para chamadas à API POST/PUT/PATCH. Use para um corpo de conteúdo vazio; caso contrário, as chamadas à API receberão uma resposta de erro {} 411 Comprimento Necessário.

Criando um token de API de aplicativo App Center

  1. Navegue até https://appcenter.ms e entre usando suas credenciais de 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 do meio, selecione tokens de API de aplicativo 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 o token.

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

    Acesso completo: Um token de API de aplicativo de acesso completo tem o equivalente de permissões de Gerenciador para esse aplicativo. Somente os gerentes podem criar tokens de API de aplicativo de acesso completo.

    Somente leitura: Um token de API de aplicativo somente leitura tem o equivalente de permissões de acesso de 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, você não pode 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 App Center

  1. Navegue até https://appcenter.ms e entre usando suas credenciais de conta.

  2. No canto superior direito do portal de App Center, clique em seu avatar de conta e selecione configurações de conta.

  3. No painel central, selecione tokens de API de usuário 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 o token.

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

    Acesso completo: Um token de API de Usuário de acesso completo 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 completo.

    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 Usuário somente leitura, você pode ler dados de falhas, análise e obter informações básicas do aplicativo. Tokens de API de Usuário somente leitura não podem alterar as configurações do aplicativo, disparar um build, 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, você não pode 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 App Center de um aplicativo, você deve incluir o token de API no título de cada solicitação enviada ao App Center.

Passe o token de API na propriedade de X-API-Token título da solicitação.

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

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

Por exemplo, a chamada à 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 App Center ou usando a CLI App Center .

Encontrar owner_name e app_name de uma URL App Center dados

  1. Navegue até https://appcenter.ms.
  2. Navegue até seu aplicativo.
  3. Quando você examina a 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:

Proprietário URL Nome do proprietário Nome do aplicativo
Usuário https://appcenter.ms/users/AlexLerxst/apps/Caravan-01 AlexLerxst Caravan-01
Organização https://appcenter.ms/orgs/BallardFlowers/apps/BouquetOrders-app BallardFlowers BouquetOrders-aplicativo

Localizar owner_name e app_name da 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

App Center CLI 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 de funções de linha de comando.

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

A especificação de App Center openapi manipula a autenticação de API para você, de modo que você não precisa colar o token de API em cabeçalhos para suas solicitações. Para testar App Center APIs com seu token de API:

  1. Navegue até a especificação de 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.

    Definindo o token de API para autorizar o uso de App Center

  4. Se ele Mostrar "autorizado" e um botão de logout, 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 à API usando o OpenAPI (Swagger)

Esta seção mostra como usar a página openapi do App Center usando a chamada à API GET /v0.1/user . Essa chamada à 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 de especificação OpenAPI a usar o token de API seguindo as instruções na seção anterior.
  3. Em conta, clique em ativado 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. Maravilha! 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 de App Center.

Revogando um token de API de usuário

  1. Navegue até https://appcenter.ms.
  2. No canto superior direito do portal de App Center, clique em seu avatar de conta e selecione configurações de conta.
  3. No painel central, selecione tokens de API de usuário 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 de API de 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 central, selecione tokens de API de aplicativo no menu.
  5. Marque a caixa ao lado do token que você deseja revogar e clique no botão excluir no canto superior direito.