O PowerApps pode usar quaisquer APIs RESTful hospedadas em qualquer lugar. Este tutorial demonstra como registrar e usar uma API personalizada.

Pré-requisitos

  • Uma conta do PowerApps.
  • Um arquivo do Swagger (JSON) OU uma URL para uma definição de Swagger para sua API personalizada. Se você não tiver um, mostraremos várias opções para criar o arquivo do Swagger.
  • Uma imagem a ser usada como um ícone para sua API personalizada (opcional).

Autenticação

APIs personalizadas no PowerApps podem usar qualquer um dos vários mecanismos de autenticação

  • Chave de API
  • Autenticação Básica
  • OAuth 2.0 genérico
  • OAuth 2.0. No momento, as implementações específicas abaixo têm suporte, e outras mais também terão em breve.

    • Azure Active Directory
    • Box
    • Dropbox
    • Facebook
    • Google
    • Instagram
    • OneDrive
    • SalesForce
    • Slack
    • Yammer

A especificação OpenAPI descreve como especificar a autenticação em um Swagger.

Se o ponto de extremidade de API permitir acesso não autenticado, você deverá remover o objeto securityDefintions do arquivo OpenAPI (Swagger). No exemplo a seguir, remova tudo do objeto securityDefintions a seguir:

  "securityDefinitions": {
    "AAD": {
      "type": "oauth2",
      "flow": "implicit",
      "authorizationUrl": "https://login.windows.net/common/oauth2/authorize",
      "scopes": {}
    }
  },

Exemplos

Registrar uma API personalizada

Etapa 1: criar um arquivo do Swagger

É possível criar um arquivo do Swagger de qualquer ponto de extremidade de API, incluindo:

  • APIs disponíveis publicamente. Alguns exemplos incluem Spotify, Uber, Slack, Rackspace e muito mais.
  • Uma API criada e implantada em qualquer provedor de hospedagem na nuvem, incluindo o Amazon Web Services (AWS), Heroku, Aplicativos Web do Azure, Google Cloud e mais.
  • Uma API de linha de negócios personalizada implantada na sua rede, desde que a API seja exposta na Internet pública.

Quando você cria o arquivo do Swagger, é criado um arquivo JSON. Você precisará disso na Etapa 2.

Conectando-se ao Serviço de Aplicativo do Azure ou Azure Functions

Se sua API é criada com o Serviço de Aplicativo do Azure ou Azure Functions, consulte Exportando uma API hospedada no Azure para o PowerApps para saber mais.

Obtendo ajuda com arquivos do Swagger

Etapa 2: registrar a API personalizada

Agora que o arquivo do Swagger (arquivo JSON) foi gerado para a API personalizada, registre a API personalizada no PowerApps

  1. Em powerapps.com, no menu à esquerda, clique em Conexões. Em seguida, clique em ... e selecione Gerenciar APIs personalizadas no canto superior direito.

    Dica:

    Se não for possível localizar o menu, talvez ele esteja em um botão de hambúrguer no canto superior esquerdo em navegadores móveis.

    Criar API personalizada

  2. Selecione Nova API personalizada:

    Propriedades da API personalizada

    Você deverá inserir as propriedades de sua API.

    Propriedade Descrição
    definição de API do Swagger OU URL do Swagger Cole uma URL em uma definição do Swagger OU procure o arquivo JSON criado com base no Swagger.
    Nome Digite o nome de sua API personalizada.
    Carregar ícone da API Procure um arquivo de imagem para o ícone (opcional).
    Descrição Digite uma descrição da sua API personalizada (opcional).

    Selecione Avançar.

  3. Insira as propriedades de autenticação. Se o arquivo JSON usar autenticação OAuth2 no objeto securityDefintions, você deverá inserir os seguintes valores:

    Propriedade Descrição
    ID do cliente Usando um dos provedores de identidade OAuth com suporte, é fornecida uma ID do cliente. Digite essa ID do cliente.
    Segredo do cliente Digite o segredo do cliente do provedor de identidade escolhido.

    Consulte os exemplos do Azure Resource Manager e Azure WebApp para saber como configurar valores de autenticação AAD.

    Se o arquivo JSON não usar o objeto securityDefintions, talvez não serão necessários valores adicionais.

  4. Selecione Criar.

    Agora, a sua API personalizada é exibida em Personalizado.

    APIs disponíveis

    Dica:

    Se o arquivo do Swagger não for validado, poderá haver outros caracteres. Por exemplo, a maioria dos dados deve ser entre aspas, incluindo URLs de sites.

  5. Agora que a API personalizada foi registrada, é necessário criar uma conexão com a API personalizada para que ela possa ser usada em seus aplicativos. Clique no + à direita da data Modificada da sua API personalizada e, em seguida, conclua as etapas necessárias para conectar-se na fonte de dados da sua API. Se você estiver usando a autenticação OAuth com sua API, talvez você se deparará com uma tela de conexão. Para a autenticação de chave de API, talvez você deva inserir um valor de chave.

Etapa 3: adicionar a API personalizada a um aplicativo

Adicione a API personalizada a um aplicativo como você faria com qualquer outra fonte de dados e, em seguida, use a API dentro da barra de funções, de uma caixa de texto e muito mais. Por exemplo, na barra de funções, é possível começar digitando MySampleWebAPI para ver as funções disponíveis. O Outlook do Office 365 é um exemplo de como usar a API do Office 365.

Compartilhar uma API personalizada

Os usuários também podem compartilhar APIs personalizadas entre si.

  1. Em powerapps.com, no menu à esquerda, clique em Conexões. Em seguida, clique em ... e selecione Gerenciar APIs personalizadas no canto superior direito.

    Nova conexão

  2. Selecione sua API, selecione Compartilhar e, em seguida, insira os usuários ou grupos aos quais você deseja permitir acesso à sua API.

    Compartilhar API personalizada

  3. Selecione Salvar.

Observação:

Só é possível compartilhar APIs personalizadas com outros usuários na sua organização.

Cotas e limitação

  • Consulte a página Preços do PowerApps para obter detalhes sobre cotas de criação de APIs personalizadas. As APIs personalizadas compartilhadas com você não são consideradas nessa cota.
  • Para cada conexão criada em uma API personalizada, os usuários podem criar até 500 solicitações por minuto.
  • Tenha em mente que a exclusão de uma API personalizada exclui todas as conexões criadas para a API.
  • O tamanho do seu arquivo do Swagger deve ser de aproximadamente 1 MB.

Próximas etapas

Saiba mais sobre extensões personalizadas do Swagger.

Usar uma API Web ASP.NET.

Registrar uma API do Azure Resource Manager.