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 as soluções, primeiro leia Criar uma solução.

A sua solução deve estar associada a uma publicadora. 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 sua solução. As instruções a seguir usam o valor sample como o prefixo de personalização porque é o definido para o publicador.

Importante

• Agora há uma experiência melhor para criar APIs personalizadas. Você pode usar um designer dentro da ferramenta de registro de plug-in. Para obter mais informações: Criar uma API personalizada usando a ferramenta de registro de plug-in
• Muitos campos relacionados à criação de API personalizada não podem ser alterados depois de criados. Você deve planejar cuidadosamente o design da API personalizada antes de começar. Se, mais tarde, você decidir que precisa alterar as coisas depois de criar a API personalizada, talvez seja necessário excluir o registro existente e recriar a API personalizada. Analise as informações sobre as colunas que não podem ser alteradas aqui: Tabelas API personalizadas

Criar um registro de API personalizado

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

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

   Não é possível definir valores para Tipo de plug-in antes de criar o plug-in. Pode alterar isto mais tarde.

3. Selecione Guardar. Seu formulário deve ter esta aparência:

Criar quaisquer 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. Na sua solução, selecione Novo>Mais>Outro>Parâmetro de Solicitação de API Personalizado na lista suspensa.

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

3. Selecione Guardar. Seu formulário deve ter esta aparência:

   

Criar quaisquer propriedades 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 bem-sucedida. Se falhar, devolve um erro. Você deve definir 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. Na sua solução, selecione Nova>Mais>Outra>Propriedade de Resposta de API Personalizada no menu pendente.

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

3. Selecione Guardar. Seu formulário deve ter esta aparência:

   

Observe o resultado no documento de serviço

Se você não tiver definido a IsPrivate propriedade para sua API personalizada, agora poderá recuperar a definição de serviço do documento CSDL $metadata usando uma GET solicitação, mesmo do navegador. Se o url do seu ambiente for https://yourorg.crm.dynamics.com, você pode digitar esse 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 encontrar 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>

Teste sua API personalizada

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

Atualize o tipo de plug-in da API personalizada

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

Depois de registrar seu assembly, você precisa definir o valor Plugin Type para a API personalizada que você criou. Esta é uma propriedade de procura, portanto, só precisa de identificar o Tipo de Plug-in que representa o tipo criado quando registou a assemblagem.

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. Para obter 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 permita a criação de APIs personalizadas fora do designer. Como os dados para APIs personalizadas são armazenados em tabelas, você pode criá-los usando código. Para obter mais informações: Crie uma API personalizada com código.

Seu processo de ALM pode ser melhor servido pela criação de APIs personalizadas editando arquivos de solução. Para obter mais informações: Crie uma API personalizada com arquivos de solução.

Consulte também

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