Udostępnij za pośrednictwem

Programowanie przy użyciu interfejsów API REST dla Serwer raportów usługi Power BI

  • Artykuł

Serwer raportów usługi Power BI obsługują interfejsy API rest (Representational State Transfer). Interfejsy API REST to punkty końcowe usługi, które obsługują zestaw operacji HTTP (metod), które zapewniają tworzenie, pobieranie, aktualizowanie lub usuwanie dostępu do zasobów na serwerze raportów.

Interfejs API REST zapewnia programowy dostęp do obiektów w katalogu Serwer raportów usługi Power BI. Przykłady obiektów to foldery, raporty, kluczowe wskaźniki wydajności, źródła danych, zestawy danych, plany odświeżania, subskrypcje i inne. Za pomocą interfejsu API REST można na przykład nawigować po hierarchii folderów, odnajdywać zawartość folderu lub pobierać definicję raportu. Można również tworzyć, aktualizować i usuwać obiekty. Przykłady pracy z obiektami to przekazywanie raportu, wykonywanie planu odświeżania, usuwanie folderu itd.

Uwaga

Jeśli interesuje Cię wyświetlanie lub usuwanie danych osobowych, zapoznaj się ze wskazówkami firmy Microsoft w temacie Żądania podmiotów danych systemu Windows dotyczące witryny RODO . Jeśli szukasz ogólnych informacji na temat RODO, zobacz sekcję RODO w portalu zaufania usług.

Składniki żądania/odpowiedzi interfejsu API REST

Para żądań/odpowiedzi interfejsu API REST może być rozdzielona na pięć składników:

  • Identyfikator URI żądania, który składa się z: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. Mimo że identyfikator URI żądania jest dołączony do nagłówka komunikatu żądania, nazywamy go oddzielnie tutaj, ponieważ większość języków lub struktur wymaga przekazania go oddzielnie od komunikatu żądania.

    • Schemat identyfikatora URI: wskazuje protokół używany do przesyłania żądania. Na przykład: http lub https.
    • Host identyfikatora URI: określa nazwę domeny lub adres IP serwera, na którym jest hostowany punkt końcowy usługi REST, taki jak myserver.contoso.com.
    • Ścieżka zasobu: określa zasób lub kolekcję zasobów, która może zawierać wiele segmentów używanych przez usługę podczas określania wyboru tych zasobów. Na przykład: CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties można użyć polecenia , aby uzyskać określone właściwości elementu CatalogItem.
    • Ciąg zapytania (opcjonalnie): udostępnia dodatkowe proste parametry, takie jak wersja interfejsu API lub kryteria wyboru zasobów.

  • Pola nagłówka komunikatu żądania HTTP:

    • Wymagana metoda HTTP (nazywana również operacją lub zleceniem), która informuje usługę o żądanym typie operacji. Interfejsy API REST usług Reporting Services obsługują metody DELETE, GET, HEAD, PUT, POST i PATCH.
    • Opcjonalne dodatkowe pola nagłówka zgodnie z wymaganiami określonego identyfikatora URI i metody HTTP.

  • Opcjonalne pola treści komunikatu żądania HTTP do obsługi identyfikatora URI i operacji HTTP. Na przykład operacje POST zawierają obiekty zakodowane w formacie MIME, które są przekazywane jako parametry złożone. W przypadku operacji POST lub PUT typ kodowania MIME dla treści powinien być również określony w nagłówku Content-type żądania. Niektóre usługi wymagają użycia określonego typu MIME, takiego jak application/json.

  • Pola nagłówka komunikatu odpowiedzi HTTP:

    • Kod stanu HTTP, od kodów powodzenia 2xx do kodów błędów 4xx lub 5xx. Alternatywnie może zostać zwrócony kod stanu zdefiniowany przez usługę, zgodnie z opisem w dokumentacji interfejsu API.
    • Opcjonalne dodatkowe pola nagłówka, zgodnie z wymaganiami do obsługi odpowiedzi żądania, takie jak Content-type nagłówek odpowiedzi.

  • Opcjonalne pola treści komunikatu odpowiedzi HTTP:

    • Obiekty odpowiedzi zakodowane w formacie MIME są zwracane w treści odpowiedzi HTTP, takie jak odpowiedź z metody GET zwracającej dane. Zazwyczaj te obiekty są zwracane w formacie ustrukturyzowanym, takim jak JSON lub XML, zgodnie z nagłówkiem Content-type odpowiedzi.

Dokumentacja interfejsu API

Nowoczesny interfejs API REST wywołuje nowoczesną dokumentację interfejsu API. Interfejs API REST jest oparty na specyfikacji interfejsu OpenAPI (czyli specyfikacji struktury Swagger), a dokumentacja jest dostępna w witrynie Microsoft Learn.

Testowanie wywołań interfejsu API

Narzędzie do testowania komunikatów żądania/odpowiedzi HTTP to Fiddler. Fiddler to bezpłatny serwer proxy debugowania internetowego, który może przechwytywać żądania REST, co ułatwia diagnozowanie komunikatów żądania HTTP/odpowiedzi.

Powiązana zawartość

Przejrzyj dostępne interfejsy API w witrynie Microsoft Learn.

Przykłady są dostępne w witrynie GitHub. Przykład zawiera aplikację HTML5 utworzoną na platformie TypeScript, React i webpack wraz z przykładem programu PowerShell.

Masz więcej pytań? Spróbuj zadać Społeczność usługi Power BI