Criar uma API personalizada no Power Apps

Ao criar uma API personalizada, você deve usar uma solução. Se você não estiver familiarizado com soluções, primeiro leia Criar uma solução.

Sua solução deve ser associada a um publicador. O publicador tem um prefixo de personalização específico associado a ele. Você deve usar um prefixo de personalização ao criar uma API personalizada e esse prefixo deve ser o mesmo usado pelo editor da solução. As instruções a seguir usam o valor sample como o prefixo de personalização porque ele é o único conjunto para o publicador.

Criar um registro de API personalizado

1. Em sua solução, selecione Nova>Mais>Outra>API personalizada na lista suspensa.

2. Edite os campos para definir as propriedades da API personalizada. Você deve definir valores para os campos a seguir. Para obter mais informações, consulte as colunas da tabela de API personalizadas

   Você não pode definir valores para o Tipo de Plug-in antes de criar o plug-in. Você pode alterar isso mais tarde.

3. Clique em Salvar. Seu formulário deve ser semelhante a este:

Criar os parâmetros de solicitação

Uma API personalizada não requer parâmetros. Crie quantos parâmetros precisar para passar os dados necessários para sua lógica.

1. Em sua solução, selecione Novo>Mais>Outro>Parâmetro de Solicitação de API Personalizada na lista suspensa.

2. Edite os campos para definir as propriedades do parâmetro de solicitação de API personalizado. Para obter mais informações, consulte Colunas da tabela CustomAPIRequestParameter

3. Clique em Salvar. Seu formulário deve ser semelhante a este:

   

Criar qualquer propriedade de resposta

Uma API personalizada que representa uma Ação não requer propriedades de resposta. Uma função deve ter pelo menos uma. Se a operação for bem-sucedida, ela retornará uma resposta de êxito. Se falhar, ele retornará um erro. Você deve definir as propriedades de resposta para todos os dados retornados pela API.

Se houver apenas uma única propriedade de resposta Entity ou EntityCollection definida, a resposta será desse tipo. Se houver várias propriedades ou uma ou mais propriedades de um tipo simples, a API retornará um tipo complexo em que cada propriedade de resposta é uma propriedade desse tipo complexo.

Por exemplo, se o nome exclusivo da API personalizada for sample_CustomAPIExample, ele retornará um tipo complexo nomeado sample_CustomAPIExampleResponse com propriedades para cada propriedade de resposta que você definir.

1. Em sua solução, selecione Novo>Mais>Outro>Propriedade de Resposta da API Personalizada na lista suspensa.

2. Edite os campos para definir as propriedades da propriedade de resposta da API personalizada. Para obter mais informações, consulte Colunas de Tabela CustomAPIResponseProperty

3. Clique em Salvar. Seu formulário deve ser semelhante a este:

   

Observe o resultado no documento de serviço

Se você ainda não definiu a IsPrivate propriedade para sua API personalizada, agora poderá recuperar a definição de serviço do documento $metadata CSDL usando uma solicitação GET , mesmo do navegador. Se a URL do seu ambiente for https://yourorg.crm.dynamics.com, você poderá digitar essa URL no campo de endereço do navegador para recuperar o $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Pesquise o resultado para localizar o nome da API personalizada. Por exemplo, a API definida usando as etapas acima tem esta aparência:

<ComplexType Name="sample_CustomAPIExampleResponse">
    <Property Name="StringProperty" Type="Edm.String" Unicode="false" />
</ComplexType>
<Action Name="sample_CustomAPIExample">
    <Parameter Name="StringParameter" Type="Edm.String" Nullable="false" Unicode="false" />
    <ReturnType Type="mscrm.sample_CustomAPIExampleResponse" Nullable="false" />
</Action>

Testar sua API personalizada

Depois de criar sua API personalizada, você poderá experimentá-la. Mesmo que você não tenha definido um tipo de plug-in para definir a operação principal, você pode testá-la agora para verificar se você pode chamá-la corretamente. Todas as propriedades de resposta retornam seu valor padrão, como nulo. Mais informações: invocando APIs personalizadas.

Atualizar o tipo de plug-in de API personalizado

Para obter informações sobre como gravar um plug-in para uma API personalizada, consulte Gravar um plug-in para sua API personalizada.

Depois de registrar o assembly, você precisará definir o valor do Tipo de Plug-in para a API personalizada criada. Esta é uma propriedade de pesquisa, portanto, você só precisa encontrar o tipo de plug-in que representa o tipo criado quando você registrou o assembly.

Depois de definir o Tipo de Plug-in, você pode testar sua API personalizada para verificar se os resultados corretos são retornados.

Outras maneiras de criar APIs personalizadas

A ferramenta de registro de plug-in fornece um designer de API personalizado. Mais informações: Criar uma API personalizada usando a ferramenta de registro de plug-in

Você pode ter requisitos para criar um aplicativo cliente que permite a criação de APIs personalizadas fora do designer. Como os dados das APIs personalizadas são armazenados em tabelas, você pode criá-los usando código. Mais informações: criar uma API personalizada com código.

Seu processo ALM pode ser melhor servido ao criar APIs personalizadas e editar arquivos de solução. Mais informações: criar uma API personalizada com arquivos de solução.

Consulte também

Criar e usar APIs personalizadas
Criar uma API personalizada usando a ferramenta de registro de plug-in
Criar uma API personalizada com código
Criar uma API personalizada com arquivos de solução
Criar suas próprias mensagens