Crear una API personalitzada al Power Apps

Aquest article explica com crear una API personalitzada a Power Apps for Microsoft Dataverse utilitzant una solució. Segueix aquests passos per definir propietats de petició i resposta, prova l'API personalitzada i associa el seu tipus de connector. Si no estàs familiaritzat amb solucions, primer llegeix Crea una solució.

La solució ha d'estar associada a un editor. L'editor té un prefix de personalització específic associat. Has d'utilitzar un prefix de personalització quan creïs una API personalitzada, i aquest prefix hauria de ser el mateix que utilitza l'editor de la teva solució. Les instruccions següents utilitzen el valor sample com a prefix de personalització perquè és el definit per a l'editor.

Important

  • Ara hi ha una millor experiència per crear API personalitzades. Podeu utilitzar un dissenyador a l'eina de registre de complements. Per a més informació, vegeu Crear una API personalitzada utilitzant l'eina de registre de connectors.
  • No pots canviar molts camps relacionats amb la creació d'API personalitzada després de crear-los. Planifica amb cura el disseny de l'API personalitzada abans de començar. Si més endavant decideixes que cal canviar aquests camps, potser hauràs d'eliminar el registre existent i recrear l'API personalitzada. Per a més informació, vegeu taules CustomAPI.

Crear un registre d'API personalitzat

  1. A la solució, seleccioneu Crea>més>altres API>personalitzades al menú desplegable.

  2. Editeu els camps per definir les propietats de l'API personalitzada. Estableix valors per als camps següents. Per a més informació, vegeu les columnes de taules de l'API personalitzada.

    No podeu definir valors per al tipus de connector abans de crear el connector. Pots canviar aquest valor més endavant.

  3. Seleccioneu Desa. El teu formulari hauria de semblar similar a la següent imatge: Captura de pantalla del formulari personalitzat de l'API desat amb les seves propietats configurades.

Crear paràmetres de sol·licitud

Una API personalitzada no requereix paràmetres. Creeu tants paràmetres com necessiteu per passar les dades necessàries per a la vostra lògica.

  1. A la solució, seleccioneu Nou>més>altres>paràmetres de sol·licitud d'API personalitzats al menú desplegable.

  2. Edita els camps per establir les propietats del teu paràmetre personalitzat de sol·licitud d'API. Per a més informació, vegeu Columnes de la Taula CustomAPIRequestParameter.

  3. Seleccioneu Desa. La teva forma hauria de semblar-se a la següent imatge:

    Captura de pantalla d'un exemple de formulari personalitzat de paràmetres de sol·licitud d'API.

Crear propietats de resposta

Una API personalitzada que representa una acció no requereix propietats de resposta. Una funció ha de tenir-ne almenys una. Si l'operació té èxit, retorna una resposta correcta. Si falla, retorna un error. Defineix propietats de resposta per a qualsevol dada que retorni la teva API.

Si només defineixes una única propietat de resposta d'Entitat o Col·lecció d'Entitats , la resposta és d'aquest tipus. Si defineixes múltiples propietats, o una o més propietats d'un tipus simple, l'API retorna un tipus complex on cada propietat de resposta és propietat d'aquest tipus complex.

Per exemple, si el nom únic de la teva API personalitzada és sample_CustomAPIExample, retorna un tipus complex anomenat sample_CustomAPIExampleResponse amb propietats per a cada propietat de resposta que defineixis.

  1. A la solució, seleccioneu Més>>altres propietats>de resposta d'API personalitzades al menú desplegable.

  2. Edita els camps per establir les propietats de la teva propietat de resposta API personalitzada. Per a més informació, vegeu CustomAPIResponseProperty Table Columns.

  3. Seleccioneu Desa. La teva forma hauria de semblar-se a la següent imatge:

    Captura de pantalla d'un exemple de formulari personalitzat de propietat de resposta de l'API.

Observeu el resultat al document de servei

Si no configures la IsPrivate propietat per a la teva API personalitzada, pots recuperar la definició del servei del document CSDL $metadata utilitzant una GET petició, fins i tot des del navegador. Si l'URL del teu entorn és https://yourorg.crm.dynamics.com, pots escriure aquesta URL al camp d'adreça del navegador per recuperar la $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Cerqueu el resultat per trobar el nom de l'API personalitzada. Per exemple, l'API definida utilitzant els passos anteriors és així:

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

Provar l'API personalitzada

Després de crear la teva API personalitzada, la pots provar. Fins i tot si no configures un tipus de connector per definir l'operació principal, pots provar-lo ara per verificar que el pots cridar correctament. Qualsevol propietat de resposta retorna el seu valor per defecte, com ara null. Per a més informació, vegeu Invocació d'APIs personalitzades.

Actualitza el tipus de complement personalitzat de l'API

Per obtenir informació sobre com escriure un complement per a una API personalitzada, vegeu Escriure un complement per a l'API personalitzada.

Després de registrar el muntatge, heu de definir el valor Tipus de connector per a l'API personalitzada que heu creat. Aquest valor és una propietat de cerca, així que només cal trobar el tipus de complement que representa el tipus creat quan vas registrar l'assemblatge.

Captura de pantalla de la cerca utilitzada per establir el tipus de complement API personalitzat.

Després d'establir el Tipus de Plugin, pots provar la teva API personalitzada per verificar que els resultats correctes es retornen.

Altres maneres de crear API personalitzades

L'eina de registre de connectors proporciona un dissenyador d'API personalitzat. Per a més informació, vegeu Crear una API personalitzada utilitzant l'eina de registre de connectors.

És possible que tingueu requisits per crear una aplicació client que permeti la creació d'API personalitzades fora del dissenyador. Com que les dades d'APIs personalitzades s'emmagatzemen en taules, les pots crear utilitzant codi. Per a més informació, vegeu Crear una API personalitzada amb codi.

El vostre procés ALM podria estar millor servit creant API personalitzades editant fitxers de solució. Per a més informació, vegeu Crear una API personalitzada amb fitxers de solució.

Consulteu també

Crear i utilitzar API personalitzades
Crear una API personalitzada mitjançant l'eina de registre de connectors
Crear una API personalitzada amb codi
Crear una API personalitzada amb fitxers de solució
Crea els teus propis missatges

  • Last updated on