Crear unha API personalizada en Power Apps

Este artigo explica como crear unha API personalizada en Power Apps para Microsoft Dataverse usando unha solución. Segue estes pasos para definir as propiedades de petición e resposta, probar a API personalizada e asociar o seu tipo de complemento. Se non estás familiarizado coas solucións, primeiro le Crear unha solución.

A túa solución debe estar asociada a unha editorial. O editor ten un prefixo de personalización específico asociado a el. Debes usar un prefixo de personalización ao crear unha API personalizada, e este prefixo debe ser o mesmo que usa o editor da túa solución. As seguintes instrucións usan o valor sample como prefixo de personalización porque é o establecido para o editor.

Importante

  • Agora hai unha mellor experiencia para crear API personalizadas. Podes usar un deseñador dentro da ferramenta de rexistro de plug-ins. Para máis información, consulte Crear unha API personalizada usando a ferramenta de rexistro de complementos.
  • Non podes cambiar moitos campos relacionados coa creación de APIs personalizadas despois de crealos. Planifica coidadosamente o deseño da API personalizada antes de comezar. Se máis adiante decides que necesitas cambiar estes campos, pode que teñas que eliminar o rexistro existente e recrear a API personalizada. Para máis información, véxase táboas CustomAPI.

Crear un rexistro API personalizado

  1. Na túa solución, selecciona Nova>API>>personalizada no despregable.

  2. Edita os campos para establecer as propiedades da túa API personalizada. Establece valores para os seguintes campos. Para máis información, consulta as columnas da táboa API personalizada.

    Non é posible establecer valores para o tipo de módulo antes de crear o complemento. Podes cambiar este valor máis adiante.

  3. Seleccione Gardar. O teu formulario debería parecerse á seguinte imaxe: captura de pantalla do formulario API personalizado gardado coas súas propiedades configuradas.

Crear parámetros de solicitude

Unha API personalizada non require parámetros. Crea tantos parámetros como necesites para pasar os datos necesarios para a túa lóxica.

  1. Na solución, seleccione Novo>>parámetro> desolicitude de API personalizada no despregable.

  2. Edita os campos para establecer as propiedades do teu parámetro de solicitude API personalizado. Para máis información, consulte Columnas da Táboa CustomAPIRequestParameter.

  3. Seleccione Gardar. A túa forma debería parecerse á seguinte imaxe:

    Captura de pantalla dun exemplo de formulario personalizado de parámetro de solicitude de API.

Crear propiedades de resposta

Unha API personalizada que representa unha acción non require propiedades de resposta. Unha función debe ter polo menos unha. Se a operación ten éxito, devolve unha resposta exitosa. Se falla, devolve un erro. Define propiedades de resposta para calquera dato que devolve a túa API.

Se defines só unha única propiedade de resposta de Entity ou EntityCollection , a resposta é dese tipo. Se defines múltiples propiedades, ou unha ou máis propiedades dun tipo simple, a API devolve un tipo complexo onde cada propiedade de resposta é unha propiedade dese tipo complexo.

Por exemplo, se o nome único da túa API personalizada é sample_CustomAPIExample, devolve un tipo complexo nomeado sample_CustomAPIExampleResponse con propiedades para cada propiedade de resposta que definas.

  1. Na túa solución, selecciona Nova>propiedade de>>resposta API personalizada no despregable.

  2. Edita os campos para establecer as propiedades da túa propiedade personalizada de resposta da API. Para máis información, consulte Columnas da Táboa CustomAPIResponseProperty.

  3. Seleccione Gardar. A túa forma debería parecerse á seguinte imaxe:

    Captura de pantalla dun exemplo de formulario personalizado de propiedade de resposta da API.

Observar o resultado no documento de notificación

Se non configuras a IsPrivate propiedade para a túa API personalizada, podes recuperar a definición do servizo do documento CSDL $metadata usando unha GET solicitude, mesmo desde o teu navegador. Se a URL do teu entorno é https://yourorg.crm.dynamics.com, podes escribir esta URL no campo de enderezo do navegador para recuperar a $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Busca o resultado para atopar o nome da API personalizada. Por exemplo, a API definida usando os pasos anteriores é así:

<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>

Proba a túa API personalizada

Despois de crear a túa API personalizada, podes probalo. Mesmo se non configuras un tipo de complemento para definir a operación principal, podes probalo agora para verificar que podes chamalo correctamente. Todas as propiedades da resposta devolven o seu valor predeterminado, como null. Para máis información, véxase Invocación de APIs personalizadas.

Actualizar o tipo de complemento da API personalizada

Para obter información sobre como escribir un complemento para unha API personalizada, consulte Escribir un complemento para a súa API personalizada.

Despois de rexistrar a súa ensamblaxe, ten que establecer o valor Tipo de complemento para a API personalizada que creou. Este valor é unha propiedade de consulta, así que só tes que atopar o Tipo de Complemento que representa o tipo creado cando rexistraches a ensamblaxe.

Captura de pantalla da consulta usada para establecer o tipo de complemento personalizado da API.

Despois de configurar o Tipo de Plugin, podes probar a túa API personalizada para verificar que se devolven os resultados correctos.

Outras formas de crear APIs personalizadas

A ferramenta de rexistro de complementos proporciona un deseñador de API personalizado. Para máis información, consulte Crear unha API personalizada usando a ferramenta de rexistro de complementos.

Pode ter requisitos para crear unha aplicación cliente que permita a creación de API personalizadas fóra do deseñador. Como os datos das APIs personalizadas están almacenados en táboas, podes crealos usando código. Para máis información, véxase Crear unha API personalizada con código.

O seu proceso ALM pode ser mellor servido creando API personalizadas editando ficheiros de solución. Para máis información, véxase Crear unha API personalizada con ficheiros de solución.

Consulte tamén

Crear e usar API personalizadas
Crear unha API personalizada usando a ferramenta de rexistro de complementos
Crea unha API personalizada con código
Crea unha API personalizada con ficheiros de solución
Crea as túas propias mensaxes

  • Última actualización o