Power BI Rapor Sunucusu için REST API'leri ile geliştirme

Power BI Rapor Sunucusu Temsili Durum Aktarımı (REST) API'lerini destekler. REST API'leri, bir rapor sunucusundaki kaynaklar için oluşturma, alma, güncelleştirme veya silme erişimi sağlayan bir dizi HTTP işlemini (yöntemler) destekleyen hizmet uç noktalarıdır.

REST API, Power BI Rapor Sunucusu kataloğundaki nesnelere program aracılığıyla erişim sağlar. Nesnelere örnek olarak klasörler, raporlar, KPI'ler, veri kaynakları, veri kümeleri, yenileme planları, abonelikler ve daha fazlası verilebilir. REST API'yi kullanarak, örneğin klasör hiyerarşisinde gezinebilir, bir klasörün içeriğini bulabilir veya rapor tanımını indirebilirsiniz. Ayrıca nesneleri oluşturabilir, güncelleştirebilir ve silebilirsiniz. Nesnelerle çalışmaya örnek olarak rapor yükleme, yenileme planı yürütme, klasör silme vb. verilebilir.

Uyarı

Kişisel verileri görüntülemek veya silmek istiyorsanız, GDPR için Windows Veri Sahibi İstekleri sitesinde Microsoft'un kılavuzunu gözden geçirin. GDPR hakkında genel bilgi arıyorsanız Hizmet Güveni portalının GDPR bölümüne bakın.

REST API isteğinin/yanıtının bileşenleri

REST API isteği/yanıt çifti beş bileşene ayrılabilir:

• İstek URI'sinde şunlar yer alır: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. İstek URI'si istek iletisi üst bilgisine dahil olsa da, çoğu dil veya çerçeve bunu istek iletisinden ayrı olarak geçirmenizi gerektirdiğinden bunu burada ayrı olarak çağırırız.

  • URI şeması: İsteği iletmek için kullanılan protokolü gösterir. Örneğin, http veya https.
  • URI ana bilgisayarı: REST hizmet uç noktasının barındırıldığı sunucunun etki alanı adını veya IP adresini belirtir, örneğin myserver.contoso.com.
  • Kaynak yolu: Hizmet tarafından bu kaynakların seçimini belirlerken kullanılan birden çok kesimi içerebilen kaynağı veya kaynak koleksiyonunu belirtir. Örneğin: CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties CatalogItem için belirtilen özellikleri almak için kullanılabilir.
  • Sorgu dizesi (isteğe bağlı): API sürümü veya kaynak seçim ölçütleri gibi diğer basit parametreleri sağlar.

• HTTP isteği ileti üst bilgisi alanları:

  • Hizmete ne tür bir işlem istediğinizi bildiren gerekli bir HTTP yöntemi (işlem veya fiil olarak da bilinir). Reporting Services REST API'leri DELETE, GET, HEAD, PUT, POST ve PATCH yöntemlerini destekler.
  • Belirtilen URI ve HTTP yöntemi için gerekli olan diğer isteğe bağlı üst bilgi alanları.

• URI ve HTTP işlemini desteklemek için isteğe bağlı HTTP isteği ileti gövdesi alanları. Örneğin, POST işlemleri karmaşık parametre olarak geçirilen MIME ile kodlanmış nesneler içerir. POST veya PUT işlemleri için, gövde için MIME kodlama türü de istek üst bilgisinde Content-type belirtilmelidir. Bazı hizmetler, gibi application/jsonbelirli bir MIME türünü kullanmanızı gerektirir.

• HTTP yanıt iletisi üst bilgisi alanları:

  • 2xx başarı kodlarından 4xx veya 5xx hata kodlarına kadar değişen bir HTTP durum kodu. Alternatif olarak, API belgelerinde belirtildiği gibi hizmet tanımlı durum kodu döndürülebilir.
  • Diğer isteğe bağlı üst bilgi alanları, örneğin bir Content-type yanıt üst bilgisi gibi, isteğin yanıtını desteklemek için gereklidir.

• İsteğe bağlı HTTP yanıt mesajı gövdesi özellikleri:

  • MIME ile kodlanmış yanıt nesneleri, veri döndüren bir GET yönteminden gelen yanıt gibi HTTP yanıt gövdesinde döndürülür. Bu nesneler genellikle yanıt üst bilgisinde gösterildiği Content-type gibi JSON veya XML gibi yapılandırılmış bir biçimde döndürülür.

API belgeleri

Modern bir REST API, modern API belgelerini gerektirir. REST API, OpenAPI belirtimi (swagger belirtimi olarak da bilinir) üzerine kurulmuştur ve belgeler Microsoft Learn'de sağlanır.

API çağrılarını test etme

HTTP isteği/yanıt iletilerini test etme aracı Fiddler'dır. Fiddler, REST isteklerinizi kesebilen ve HTTP isteği/yanıt iletilerini tanılamayı kolaylaştıran ücretsiz bir web hata ayıklama proxy'sidir.

İlgili içerik

Microsoft Learn'de kullanılabilir API'leri gözden geçirin.

Örnekler GitHub'da bulunabilir. Örnek, TypeScript, React ve webpack üzerinde oluşturulmuş bir HTML5 uygulamasının yanı sıra bir PowerShell örneği içerir.

Başka sorunuz var mı? Power BI Topluluğu'na sormayı deneyin