Tworzenie niestandardowego interfejsu API w usłudze Power Apps

W tym artykule wyjaśniono, jak utworzyć niestandardowy interfejs API w Power Apps dla Microsoft Dataverse przy użyciu rozwiązania. Wykonaj następujące kroki, aby zdefiniować właściwości żądania i odpowiedzi, przetestować niestandardowy interfejs API i skojarzyć jego typ wtyczki. Jeśli nie znasz rozwiązań, najpierw przeczytaj artykuł Tworzenie rozwiązania.

Rozwiązanie musi być skojarzone z wydawcą. Wydawca ma powiązany z nim określony prefiks personalizacji. Należy użyć prefiksu dostosowywania podczas tworzenia niestandardowego interfejsu API, a ten prefiks powinien być tym samym prefiksem używanym przez wydawcę rozwiązania. Poniższe instrukcje używają wartości sample jako prefiksu dostosowywania, ponieważ jest to ta ustawiona dla wydawcy.

Ważne

• Teraz istnieje lepsze środowisko tworzenia niestandardowego interfejsu API. W narzędziu rejestracji dodatków plug-in można użyć projektanta. Aby uzyskać więcej informacji, zobacz Tworzenie niestandardowego interfejsu API przy użyciu narzędzia do rejestracji wtyczek.
• Nie można zmienić wielu pól związanych z tworzeniem niestandardowego interfejsu API po ich utworzeniu. Przed rozpoczęciem należy dokładnie zaplanować projekt niestandardowego interfejsu API. Jeśli później zdecydujesz, że musisz zmienić te pola, może być konieczne usunięcie istniejącego rekordu i ponowne utworzenie niestandardowego interfejsu API. Aby uzyskać więcej informacji, zobacz Tabele CustomAPI.

Tworzenie niestandardowego rekordu interfejsu API

1. W rozwiązaniu wybierz pozycję Nowy>Więcej>Inne>Niestandardowy interfejs API z listy rozwijanej.

2. Edytuj pola, aby ustawić właściwości niestandardowego interfejsu API. Ustaw wartości dla następujących pól. Aby uzyskać więcej informacji, zobacz Kolumny tabel interfejsu API niestandardowego.

   Nie można ustawić wartości dla typu wtyczki przed utworzeniem wtyczki. Tę wartość można zmienić później.

3. Wybierz Zapisz. Formularz powinien wyglądać podobnie jak na poniższej ilustracji:

Tworzenie parametrów żądania

Niestandardowy interfejs API nie wymaga parametrów. Utwórz dowolną liczbę parametrów potrzebnych do przekazania danych potrzebnych dla logiki.

1. W rozwiązaniu wybierz pozycję Nowy>Więcej>Inne>Niestandardowy parametr żądania interfejsu API z listy rozwijanej.

2. Edytuj pola, aby ustawić właściwości niestandardowego parametru żądania interfejsu API. Aby uzyskać więcej informacji, zobacz CustomAPIRequestParameter Table Columns (Kolumny tabeli CustomAPIRequestParameter).

3. Wybierz Zapisz. Formularz powinien wyglądać podobnie do poniższego obrazu:

   

Tworzenie właściwości odpowiedzi

Niestandardowy interfejs API reprezentujący akcję nie wymaga właściwości odpowiedzi. Funkcja musi mieć co najmniej jeden element. Jeśli operacja zakończy się pomyślnie, zwraca odpowiedź z informacją o powodzeniu. Jeśli operacji zakończy się niepowodzeniem, zwróci błąd. Zdefiniuj właściwości odpowiedzi dla wszystkich danych zwracanych przez interfejs API.

Jeśli zdefiniujesz tylko jedną właściwość jednostki lub odpowiedź EntityCollection , odpowiedź jest tego typu. Jeśli definiujesz wiele właściwości lub co najmniej jedną właściwość prostego typu, interfejs API zwraca typ złożony, w którym każda właściwość odpowiedzi jest właściwością tego typu złożonego.

Jeśli na przykład niestandardowa unikatowa nazwa interfejsu API to sample_CustomAPIExample, zwraca typ złożony o nazwie sample_CustomAPIExampleResponse z właściwościami dla każdej zdefiniowanej właściwości odpowiedzi.

1. W rozwiązaniu wybierz pozycję Nowy>Więcej>Inne>Właściwość odpowiedzi niestandardowego interfejsu API z listy rozwijanej.

2. Edytuj pola, aby ustawić właściwości niestandardowej właściwości odpowiedzi interfejsu API. Aby uzyskać więcej informacji, zobacz CustomAPIResponseProperty Table Columns (Kolumny tabeli CustomAPIResponseProperty).

3. Wybierz Zapisz. Formularz powinien wyglądać podobnie do poniższego obrazu:

   

Obserwuj wynik w dokumencie usługi

Jeśli nie ustawisz właściwości dla niestandardowego interfejsu IsPrivate API, możesz pobrać definicję usługi z dokumentu CSDL $metadata przy użyciu GET żądania, nawet z przeglądarki. Jeśli adres URL środowiska to https://yourorg.crm.dynamics.com, możesz wpisać ten adres URL w polu adresu przeglądarki, aby pobrać $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Przeszukaj wynik, aby znaleźć nazwę niestandardowego interfejsu API. Na przykład interfejs API zdefiniowany przy użyciu powyższych kroków wygląda następująco:

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

Testowanie niestandardowego interfejsu API

Po utworzeniu niestandardowego interfejsu API możesz go wypróbować. Nawet jeśli nie ustawisz typu wtyczki w celu zdefiniowania operacji głównej, możesz przetestować ją teraz, aby sprawdzić, czy można ją poprawnie wywołać. Wszystkie właściwości odpowiedzi zwracają wartość domyślną, taką jak null. Aby uzyskać więcej informacji, zobacz Wywoływanie niestandardowych interfejsów API.

Aktualizowanie niestandardowego typu wtyczki interfejsu API

Aby uzyskać informacje o sposobie pisania wtyczki dla niestandardowego interfejsu API, zobacz Pisanie wtyczki dla niestandardowego interfejsu API.

Po zarejestrowaniu zestawu należy ustawić wartość Typ wtyczki dla utworzonego niestandardowego interfejsu API. Ta wartość jest właściwością odnośnika, więc wystarczy znaleźć typ wtyczki, który reprezentuje typ utworzony podczas rejestrowania zestawu.

Po ustawieniu typu wtyczki możesz przetestować niestandardowy interfejs API, aby sprawdzić, czy zwracane są poprawne wyniki.

Inne sposoby tworzenia niestandardowych interfejsów API

Narzędzie do rejestracji wtyczek oferuje projektanta API dostosowanego do potrzeb. Aby uzyskać więcej informacji, zobacz Tworzenie niestandardowego interfejsu API przy użyciu narzędzia do rejestracji wtyczek.

Być może trzeba będzie utworzyć aplikację kliencką, która umożliwia tworzenie niestandardowych interfejsów API spoza projektanta. Ponieważ dane niestandardowych interfejsów API są przechowywane w tabelach, można je utworzyć przy użyciu kodu. Aby uzyskać więcej informacji, zobacz Tworzenie niestandardowego interfejsu API z kodem.

Proces ALM może być lepiej obsługiwany przez tworzenie niestandardowych interfejsów API przez edytowanie plików rozwiązań. Aby uzyskać więcej informacji, zobacz Tworzenie niestandardowego interfejsu API z plikami rozwiązań.

Zobacz także

Tworzenie i używanie niestandardowych interfejsów API
Tworzenie niestandardowego interfejsu API przy użyciu narzędzia rejestracji wtyczek
Tworzenie niestandardowego interfejsu API z kodem
Tworzenie niestandardowego interfejsu API z plikami rozwiązań
Tworzenie własnych komunikatów