Poznawanie i testowanie Dataverse w interfejsie API sieci Web (wersja zapoznawcza)
[Ten temat pochodzi ze wstępnej wersji dokumentacji i może ulec zmianie.]
Interfejs API to wstępnie uwierzytelnione narzędzie do testowania oprogramowania, które ułatwia twórcom szybkie i wygodne interakcje z interfejsem API sieci Web Microsoft Dataverse.
Ta aplikacja sieci Web umożliwia deweloperom testowanie i eksperymentowanie z różnymi punktami końcowymi interfejsów API bez konieczności szczegółowej konfiguracji ani procesów uwierzytelniania. W tym miejscu można w łatwy sposób przedstawić określone dostępne akcje i łącza do dokumentacji, aby przyspieszyć naukę.
To narzędzie pozwala poznać możliwości interfejsu API typu RESTful, przetestować przepływy pracy zdefiniowane przez użytkownika i nie tylko.
Ważne
- Jest to funkcja w wersji zapoznawczej.
- Funkcje w wersji zapoznawczej nie są przeznaczone do użytku w środowiskach produkcyjnych i mogą mieć ograniczoną funkcjonalność. Te funkcje są udostępniane przed oficjalnym wydaniem, dzięki czemu klienci mogą szybciej uzyskać do nich dostęp i przekazać opinie na ich temat.
Kluczowe cechy i funkcje
- Wstępnie uwierzytelniony: wstępne uwierzytelnienie interfejsu API jest wstępnie uwierzytelnione, dzięki czemu deweloperzy mogą od razu rozpocząć testowanie i eksperymentowanie z punktami końcowymi interfejsu API.
- Oparty na sieci Web: wraz z konfiguracją interfejsu API Dataverse deweloperzy mogą szybko współdziałać z interfejsem API sieci Web bez konieczności rozbudowy, np. pobierania oprogramowania lub konfigurowania kont innych niż Microsoft. Można uzyskać dostęp do tego narzędzia, mając dostęp do akceleratora Dataverse, aplikacji firmy Microsoft dostępnej we wszystkich nowych środowiskach Dataverse i można ją zainstalować w dowolnym środowisku.
- Wygodna: zawiera różne akcje Dataverse i funkcje dostępne w interfejsie API sieci Web, co ułatwia szybkie dowiedz się, jakie są możliwe i jak można je zaimplementować.
Wymagania wstępne
Musisz mieć dostęp do Dataverse i dostęp do testowania aplikacji akceleratora Dataverse. Członkowie grupy rola zabezpieczeń systemu mają dostęp do testowania aplikacji.
Rozpoczynanie pracy
Aby rozpocząć testowanie z interfejsem API, testuj akcelerator Dataverse, a następnie wybierz stronę Środowisko testowe interfejsu API.
Żądanie do interfejsu API sieci Web Dataverse
Na ekranie docelowym wybierz typ żądania, aby otworzyć edytor żądań, wybierając opcję Utwórz na dowolnej górnej kartce.
Zostaną przedstawione trzy typy żądań:
| Type | Podpis |
|---|---|
| Niestandardowe dane w formacie API | Obejmuje to wszystkie akcje interfejsu API Dataverse, funkcje z Microsoft lub dowolne publiczne określone przez użytkownika niestandardowe interfejsu API zarejestrowane w środowisku roboczym. |
| Wtyczka błyskawiczna | Dodatki plug-in są definiowane przez użytkownika jako niestandardowe przepływy pracy zarejestrowane w środowisku przy użyciu powiązanego z nim przepływu pracy. |
| Żądanie OData | Pozwala na bardziej ziarnistą kontrolę nad danymi wejściowymi żądania w celu wysyłania żądań OData. |
Żądanie niestandardowego interfejsu API lub błyskawicznego dodatku plug-in
Te typy żądań mają uprościć wywoływanie dodatku plug-in dostępnego w środowisku pracy.
Wybierz opcję z głównej listy rozwijanej, która zawiera dostępne dodatki plug-in w bieżącym środowisku.
Jeśli parametry są dostępne, są wyświetlane w wyświetlonej tabeli Parametry zapytania. Podaj wartości dla wymaganych parametrów.
Uwaga
Pola wyboru z lewej strony każdego parametru wskazują, czy są one uwzględnione w żądaniu. Parametry wymagane mają wyłączone pola wyboru, a parametry opcjonalne mogą być edytowalne.
Wybierz Wyślij.
Obserwuj odpowiedź w dolnej części ekranu.
Uwaga
Interfejs zawiera wygodną listę wszystkich dostępnych dodatki plug-in w środowisku. Po wybraniu tej opcji zostaną przedstawione skojarzone parametry z typami danych. Za filmami jest nadal wołane rozmowę OData, ale interfejs upraszcza proces rozmowę.
Prześlij żądanie OData
Żądania OData zezwalają na więcej opcji parametrów żądania.
Na pierwszej liście rozwijanej wybierz metodę żądania HTTP.
Wpisz punkt końcowy URL. Należy uwzględnić adres URL żądania tylko po
[OrgUrl]/api/data/v9.2/Dodaj parametry zapytania, używając jednej z dwóch metod:
W adresie URL.
Po znaku znaku zapytania (
?) w adresie URL wpisz klucz parametru zapytania.
Wpisz znak równania (
=) po kluczu.Wpisz w wartości.
Klucze i wartości zostaną automatycznie wypełnione tabelą parametrów w interfejsie.
W tym celu należy ręcznie dodać parametry zapytania, wybierając opcję + Dodaj param. Powoduje to dodanie pustego wiersza parametru do tabeli, w który można wpisać wartości. Adres URL jest aktualizowany dynamicznie po wprowadzeniu wartości.
Opcjonalnie podaj treść (jeśli używasz wszystkich metod żądań z wyjątkiem GET), wybierając kartę Treść, a następnie wprowadź wartość treści w kontrolce edytora.
Wybierz Wyślij.
Obserwuj odpowiedź w dolnej sekcji.
Wyświetl odpowiedź
Po wysłaniu żądania odpowiedź zostanie wyświetlona w dolnej połowie ekranu.
Stan odpowiedzi dostarcza szybkie metryki na żądanie:
- Komunikat o stanie
- Czas trwania (w milisekundach)
- Rozmiar (w kilobajtach)
Treść odpowiedzi jest wyświetlana poniżej stanu odpowiedzi. Wybierz ikonę kopiowania, aby skopiować treść odpowiedzi do Schowka.
— często zadawane pytania
Jakie uprawnienia są wymagane do uzyskania dostępu do narzędzia środowiska testowego interfejsu API?
Musisz mieć dostęp do Dataverse i dostęp do testowania aplikacji akceleratora, by używać narzędzia.
Czy narzędzie do usuwania interfejsów API łączy się tylko z interfejsem API sieci Web Dataverse?
Tak, narzędzie do usuwania interfejsów API łączy się tylko z interfejsem API sieci Web Dataverse. W tym interfejsie nie są dostępne żadne inne usługi.
Jak narzędzie do usuwania interfejsów API uwierzytelnia się z interfejsem API sieci Web Dataverse?
To narzędzie używa tokenu uwierzytelniania zalogowanego użytkownika, który jest wymagany do gry w aplikację akceleratora Dataverse.
Czy funkcja środowiska testowego interfejsu API jest dostępna we wszystkich środowiskach?
Ta funkcja jest dostarczana za pośrednictwem akceleratora Dataverse i jest dostępna we wszystkich środowiskach, w których zainstalowano aplikację. Aplikacja jest instalowana automatycznie we wszystkich nowych środowiskach, ale może być również instalowana w starszych środowiskach, zgodnie z instrukcjami dotyczącymi instalowania.