Crear una API personalitzada al Power Apps

Quan creeu una API personalitzada, heu d'utilitzar una solució. Si no esteu familiaritzat amb les solucions, primer llegiu Crear una solució.

La solució ha d'estar associada a un editor. L'editor té un prefix de personalització específic associat. Heu d'utilitzar un prefix de personalització quan creeu una API personalitzada i aquest prefix ha de ser el mateix que utilitza l'editor de la 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. Més informació: Crear una API personalitzada mitjançant l'eina de registre de complements
• Molts camps relacionats amb la creació d'API personalitzades no es poden canviar després de crear-los. Heu de planificar acuradament el disseny de l'API personalitzada abans de començar. Si més endavant decidiu que heu de canviar les coses després de crear l'API personalitzada, potser haureu de suprimir el registre existent i tornar a crear l'API personalitzada. Reviseu la informació sobre les columnes que no es poden canviar aquí: 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. Heu de definir valors per als camps següents. Per obtenir més informació, vegeu Columnes de taula de l'API personalitzades

   No podeu definir valors per al tipus de connector abans de crear el connector. Podeu canviar-lo més endavant.

3. Seleccioneu Desa. El formulari hauria de tenir aquest aspecte

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. Editeu els camps per definir les propietats del paràmetre de sol·licitud d'API personalitzat. Per obtenir més informació, vegeu Columnes de la taula CustomAPIRequestParameter

3. Seleccioneu Desa. El vostre formulari hauria de tenir aquest aspecte:

   

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. Heu de definir propietats de resposta per a les dades que retorni l'API.

Si només hi ha una única propietat de resposta Entity o EntityCollection definida, la resposta és d'aquest tipus. Si hi ha diverses propietats o una o més propietats d'un tipus simple, l'API retorna un tipus complex on cada propietat de resposta és una propietat d'aquest tipus complex.

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

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

2. Editeu els camps per definir les propietats de la propietat de resposta de l'API personalitzada. Per obtenir més informació, vegeu Columnes de taula CustomAPIResponseProperty

3. Seleccioneu Desa. El vostre formulari hauria de tenir aquest aspecte:

   

Observeu el resultat al document de servei

Si no heu definit la propietat de l'API IsPrivate personalitzada, ara podeu recuperar la definició del servei del document CSDL $metadata mitjançant una GET sol·licitud, fins i tot des del navegador. Si l'adreça URL del vostre entorn és https://yourorg.crm.dynamics.com, podeu escriure aquesta adreça URL al camp d'adreça del navegador per recuperar el $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 mitjançant els passos anteriors té aquest aspecte:

<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 vostra API personalitzada, podeu provar-la. Fins i tot si no heu establert un tipus de connector per definir l'operació principal, podeu provar-lo ara per verificar que podeu cridar-lo correctament. Qualsevol propietat de resposta retorna el seu valor per defecte, com ara null. Més informació: Invocar API personalitzades.

Actualitza el tipus de connector de l'API personalitzada

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. Aquesta és una propietat de cerca, de manera que només heu de trobar el tipus de complement que representa el tipus creat quan vau registrar l'assemblatge.

Un cop hàgiu establert el tipus de connector, podeu provar la vostra API personalitzada per verificar que es retornen els resultats correctes.

Altres maneres de crear API personalitzades

L'eina de registre de connectors proporciona un dissenyador d'API personalitzat. Més informació: Crear una API personalitzada mitjançant l'eina de registre de complements

És possible que tingueu requisits per crear una aplicació client que permeti la creació d'API personalitzades fora del dissenyador. Com que les dades de les API personalitzades s'emmagatzemen en taules, podeu crear-les mitjançant codi. Més informació: Crear una API personalitzada amb codi.

El vostre procés ALM podria estar millor servit creant API personalitzades editant fitxers de solució. Més informació: 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