Upravit

Sdílet prostřednictvím

Create a custom API in Power Apps

  • Článek

When creating a custom API, you must use a solution. If you are not familiar with solutions, first read Create a solution.

Your solution must be associated with a publisher. The publisher will have a specific customization prefix associated with it. You must use a customization prefix when creating a custom API and this prefix should be the same used by the publisher of your solution. The instructions below will use the value sample as the customization prefix because it is the one set for the publisher.

Important

  • There is now a better experience for creating custom API. You can use a designer within the Plug-in registration tool. More information: Create a custom API using the plug-in registration tool
  • Many fields related to creating custom API cannot be changed after you create them. You should carefully plan the design of the custom API before you start. If you later decide that you need to change things after you create the custom API, you may need to delete the existing record and re-create the custom API. Review the information about the columns that cannot be changed here: CustomAPI tables

Create a custom API record

  1. In your solution, click New > More > Other > custom API from the drop-down.

  2. Edit the fields to set the properties of your custom API. You must set values for the following fields. For more information see Custom API table columns

    You cannot set values for Plug-in Type unless you have already created the plug-in. You can change this later.

  3. Click Save. Your form should look something like this: Saved Custom API form.

Create any Request Parameters

A custom API doesn't require parameters. Create as many parameters as you need to pass data needed for your logic.

  1. In your solution, click New > More > Other > Custom API Request Parameter from the drop-down.

  2. Edit the fields to set the properties of your custom API Request Parameter. For more information see CustomAPIRequestParameter Table Columns

  3. Click Save. Your form should look something like this:

    Example of a custom API Request Parameter Form.

Create any Response Properties

A custom API that represents an Action doesn't require response properties. A Function must have at least one. If the operation succeeds, it will return a success response. If it fails, it will return an error. You should define response properties for any data that your API will return.

If there is only a single Entity or EntityCollection response property defined, the response will be of that type. If there are multiple properties, or one or more property of a simple type, the API will return a complex type where each response property will be a property of that complex type.

For example, if your custom API Unique name is sample_CustomAPIExample, it will return a complex type named sample_CustomAPIExampleResponse with properties for each response property you define.

  1. In your solution, click New > More > Other > Custom API Response Property from the drop-down.

  2. Edit the fields to set the properties of your custom API Response Property. For more information see CustomAPIResponseProperty Table Columns

  3. Click Save. Your form should look something like this:

    Custom API Response Property Form.

Observe the result in the service document

If you haven't set the IsPrivate property for your custom API, you can now retrieve the service definition from the CSDL $metadata document using a GET request, even from your browser. If the url for your environment is https://yourorg.crm.dynamics.com, you can type this URL in your browser address field to retrieve the $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Search the result to find the name of the custom API. For example, the API defined using the steps above looks like this:

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

Test your custom API

Now that you have created your custom API you can try it. Even if you haven't set a plug-in type to define the main operation, you can test it now to verify that you can call it correctly. Any response properties will return their default value, such as null. More information: Invoking custom APIs.

Update the custom API Plugin Type

For information about how to write a plug-in for a custom api, see Write a Plug-in for your custom API.

After you have registered your assembly, you need to set the Plugin Type value for the custom API you created. This is a lookup property, so you just need to find the Plug-in Type that represents the type created when you registered the assembly.

Set the custom API Plugin Type Lookup.

Once you have set the Plugin Type, you can test your custom API to verify the correct results are returned.

Other ways to create custom APIs

The plugin registration tool provides a custom API designer. More information: Create a custom API using the plug-in registration tool

You may have requirements to create a client application which will allow creation of custom APIs outside of the designer. Because the data for custom APIs is stored in tables, you can create them using code. More information: Create a custom API with code.

Your ALM process may be better served by creating custom APIs by editing solution files. More information: Create a custom API with solution files.

See also

Create and use custom APIs
Create a custom API using the plug-in registration tool
Create a custom API with code
Create a custom API with solution files
Create your own messages