Odkryj adres URL swojej organizacji, korzystając z interfejsu API sieci Web

Usługa odnajdywania dla internetowego interfejsu API Dynamics 365 for Customer Engagement umożliwia aplikacjom określanie w czasie rzeczywistym, do których organizacji, nazywanych również wystąpieniami, należy zalogowany użytkownik. Możesz pobrać szczegółowe informacje o tych wystąpieniach, takie jak adres URL usługi wystąpienia, wersja wersji Customer Engagement, identyfikator wystąpienia i inne. Możesz użyć standardowych $filter i $select parametrów w żądaniu do usługi Web API w celu dostosowania zwróconej listy danych wystąpienia.

Uwaga / Notatka

Dokumentacja, która ma zastosowanie do użytkowników online, jest teraz dostępna w dokumentacji Power Apps pod adresem: Odnajdywanie adresu URL organizacji przy użyciu internetowego interfejsu API.

Aplikacje klienckie mogą potrzebować dostępu do wystąpienia Customer Engagement, w którym adres URL wystąpienia może się zmieniać z czasem. Na przykład, gdy instancja obsługi klienta (Customer Engagement) jest przenoszona z jednego lokalnego centrum danych do innego. Usługa Discovery pozwala egzemplarzowi klienta na zapisanie identyfikatora egzemplarza lub unikalnej nazwy egzemplarza, a następnie skorzystanie z usługi Discovery, aby odszukać aktualny adres URL dostępu do egzemplarza.

Informacje dostarczane przez usługę Discovery

Informacje o organizacji są przechowywane w Instance encji usługi Discovery. Aby wyświetlić rodzaj informacji zawartych w tej jednostce, wyślij żądanie HTTP GET do usługi dla jednego z wystąpień.

GET https://dev.{servername}/api/discovery/v9.1/Instances(UniqueName='myorg')  

W powyższym przykładzie usługa odnajdywania służy do uzyskania informacji o organizacji instancji o unikalnej nazwie "myorg". Więcej szczegółów na temat tego żądania zostało rozwiniętych w dalszej części tego tematu.

Zakres zwracanych informacji

W przypadku usługi odnajdywania regionalnego Instances zestaw jednostek zwraca zestaw wystąpień, do których użytkownik ma dostęp w określonej lokalizacji geograficznej, gdy nie są stosowane żadne filtry. Zwracane dane mają zakres opisany poniżej.

• Nie obejmuje przypadków, w których konto użytkownika jest wyłączone

• Nie obejmuje przypadków, gdzie użytkownicy zostali odfiltrowani na podstawie grupy zabezpieczeń instancji

• Nie obejmuje przypadków, w których użytkownik ma dostęp w wyniku bycia administratorem delegowanym

• Jeśli użytkownik wywołujący nie ma dostępu do żadnych wystąpień, odpowiedź po prostu zwraca pustą listę

Jak uzyskać dostęp do usług odnajdywania

Ogólnie rzecz biorąc, adres internetowego interfejsu API usługi odnajdywania ma następujący format: <service base address>/api/discovery/. Adresy dla każdego typu wdrożenia są określone poniżej. Adresy i numer wersji internetowego interfejsu API dla danego wdrożenia można łatwo znaleźć w aplikacji sieci Web Customer Engagement, przechodząc do sekcji Dostosowywanie > ustawień > Zasoby dla deweloperów.

Podstawowy adres usługi odnajdywania dla wdrożenia lokalnego lub IFD to : http[s]://{servername}/ lub http[s]://dev.{servername}/. Powoduje to adres usługi http[s]://{servername}/api/discovery/ lub http[s]://dev.{servername}/api/discovery/.

Korzystanie z usługi odnajdywania

Zestaw jednostek o nazwie Instances jest używany do uzyskiwania informacji o wystąpieniu. Możesz użyć $select i $filter z zestawem encji Wystąpienia do filtrowania zwracanych danych. Możesz również użyć $metadata do uzyskania dokumentu metadanych usługi.

Uwierzytelnianie

Instancje lokalne lub IFD interfejsu API RESTful odnajdywania OData V4 przyjmują model uwierzytelniania zgodny ze swoją konfiguracją, obsługując zintegrowane uwierzytelnianie Systemu Windows (IWA) lub tokeny OAuth od zaufanego dostawcy usług tokenowych. Uwierzytelnianie sesji aplikacji internetowej nie jest obsługiwane.

Wersjonowanie internetowego interfejsu API

Wersjonowanie usługi odnajdywania dla centrum danych lub instalacji lokalnej/IFD jest obsługiwane i jest zgodne z numeracją wersji używanej przez usługę organizacyjną. Przykład:

GET https://dev.{servername}/api/discovery/v9.1/Instances(UniqueName='myorg')  

Obsługa mechanizmu CORS

Interfejs API RESTful usługi odnajdywania obsługuje standard CORS do dostępu między źródłami, podobnie jak interfejs API sieci Web. Aby uzyskać więcej informacji na temat obsługi mechanizmu CORS , zobacz Używanie protokołu OAuth z udostępnianiem zasobów między źródłami w celu nawiązania połączenia z aplikacją jednostronicową.

Przykłady

• Uzyskaj szczegółowe informacje o konkretnym wystąpieniu. Jeśli pominiesz identyfikator GUID, zostaną zwrócone wszystkie wystąpienia, do których uwierzytelniony użytkownik ma dostęp.

  GET https://dev.{servername}/api/discovery/v9.1/Instances(<guid>)  
  

• Atrybutu UniqueName można użyć jako klucza alternatywnego.

  GET https://dev.{servername}/api/discovery/v9.1/Instances(UniqueName='myorg')  
  

• Pobierz listę dostępnych wystąpień filtrowanych według typu produkcji.

  GET https://dev.{servername}/api/discovery/v9.1/Instances?$select=DisplayName,Description&$filter=Type+eq+0   
  

• Pobierz wartość właściwości ID określonego wystąpienia.

  GET https://dev.{servername}/api/discovery/v9.1/Instances(UniqueName='myorg')/Id/$value  
  

Zobacz także

Przykład usługi odnajdywania globalnego interfejsu API sieci Web (C#)