Power Apps'te özel API oluşturma

Bu makalede, bir çözüm kullanarak Microsoft Dataverse için Power Apps'de özel API oluşturma açıklanmaktadır. İstek ve yanıt özelliklerini tanımlamak, özel API'yi test etmek ve eklenti türünü ilişkilendirmek için bu adımları izleyin. Çözümler hakkında bilginiz yoksa, önce Çözüm oluşturma'yı okuyun.

Çözümünüz bir yayımcıyla ilişkilendirilmelidir. Yayımcının kendisiyle ilişkilendirilmiş belirli bir özelleştirme ön eki vardır. Özel API oluştururken özelleştirme ön eki kullanmanız gerekir ve bu ön ek, çözümünüzün yayımcısı tarafından kullanılan ön ekle aynı olmalıdır. Yayımcı için ayarlanan özelleştirme ön eki olarak sample değeri aşağıdaki yönergelerde kullanılır.

Önemli

  • Artık özel API oluşturmak için daha iyi bir deneyim var. Eklenti kayıt aracında bir tasarımcı kullanabilirsiniz. Daha fazla bilgi için bkz. Eklenti kayıt aracını kullanarak özel API oluşturma.
  • Özel API oluşturmayla ilgili birçok alanı oluşturduktan sonra değiştiremezsiniz. Başlamadan önce özel API'nin tasarımını dikkatlice planlayın. Daha sonra bu alanları değiştirmeniz gerektiğine karar verirseniz, mevcut kaydı silmeniz ve özel API'yi yeniden oluşturmanız gerekebilir. Daha fazla bilgi için bkz . ÖzelAPI tabloları.

Özel API kaydı oluşturma

  1. Çözümünüzde açılan listeden Yeni>Diğer>Özel>API'yi seçin.

  2. Özel API'nizin özelliklerini ayarlamak için alanları düzenleyin. Aşağıdaki alanların değerlerini ayarlayın. Daha fazla bilgi için bkz. Özel API tablo sütunları.

    Eklentiyi oluşturmadan önce Eklenti Türü için değer ayarlayamazsınız. Bu değeri daha sonra değiştirebilirsiniz.

  3. Kaydetseçeneğini seçin. Formunuz aşağıdaki görüntüye benzer görünmelidir: Yapılandırılmış özellikleriyle kaydedilmiş özel API formunun ekran görüntüsü.

İstek parametreleri oluşturma

Özel API için parametre gerekmez. Mantığınız için gereken verileri geçirmek için gereken sayıda parametre oluşturun.

  1. Çözümünüzde, açılan listeden Yeni>Diğer Diğer>>Özel API İstek Parametresi'ni seçin.

  2. Özel API istek parametrenizin özelliklerini ayarlamak için alanları düzenleyin. Daha fazla bilgi için bkz. CustomAPIRequestParameter Tablo Sütunları.

  3. Kaydetseçeneğini seçin. Formunuz aşağıdaki görüntüye benzer görünmelidir:

    Örnek bir özel API isteği parametre formunun ekran görüntüsü.

Yanıt özellikleri oluşturma

Eylemi temsil eden özel bir API yanıt özellikleri gerektirmez. İşlevin en az bir işlevi olmalıdır. İşlem başarılı olursa, bir başarı yanıtı döndürür. Başarısız olursa bir hata döndürür. API'nizin döndürdüğü tüm veriler için yanıt özelliklerini tanımlayın.

Yalnızca tek bir Entity veya EntityCollection yanıt özelliği tanımlarsanız, yanıt bu türdedir. Birden çok özellik veya basit bir türün bir veya daha fazla özelliğini tanımlarsanız, API her yanıt özelliğinin bu karmaşık türün bir özelliği olduğu karmaşık bir tür döndürür.

Örneğin, özel API'nizin benzersiz adı ise sample_CustomAPIExample, tanımladığınız her yanıt özelliğinin özellikleriyle adlı sample_CustomAPIExampleResponse karmaşık bir tür döndürür.

  1. Çözümünüzde açılan listeden Yeni>Diğer>Diğer>Özel API Yanıt Özelliği'ni seçin.

  2. Özel API yanıt özelliğinizin özelliklerini ayarlamak için alanları düzenleyin. Daha fazla bilgi için bkz. CustomAPIResponseProperty Tablo Sütunları.

  3. Kaydetseçeneğini seçin. Formunuz aşağıdaki görüntüye benzer görünmelidir:

    Örnek bir özel API yanıt özelliği formunun ekran görüntüsü.

Hizmet belgesindeki sonucu gözlemleyin

Özel API'nizin özelliğini ayarlamazsanızIsPrivate, tarayıcınızdan bile istek GET kullanarak CSDL $metadata belgesinden hizmet tanımını alabilirsiniz. Ortamınızın URL'si ise https://yourorg.crm.dynamics.com, $metadata almak için tarayıcı adres alanınıza bu URL'yi yazabilirsiniz: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Özel API'nin adını bulmak için sonucu arayın. Örneğin, önceki adımlar kullanılarak tanımlanan API şöyle görünür:

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

Özel API'nizi test edin

Özel API'nizi oluşturduktan sonra deneyebilirsiniz. Ana işlemi tanımlamak için bir eklenti türü ayarlamasanız bile, doğru çağırabildiğinizi doğrulamak için şimdi test edebilirsiniz. Tüm yanıt özellikleri null gibi varsayılan değerlerini döndürür. Daha fazla bilgi için bkz. Özel API'leri çağırma.

Özel API eklenti türünü güncelleştirme

Özel api için eklenti yazma hakkında bilgi için bkz. Özel API'niz için eklenti yazma.

Derlemenizi kaydettikten sonra, oluşturduğunuz özel API için Eklenti Türü değerini ayarlamanız gerekir. Bu değer bir arama özelliği olduğundan, derlemeyi kaydettiğinizde oluşturulan türü temsil eden Eklenti Türü'nü bulmanız yeterlidir.

Özel API eklenti türünü ayarlamak için kullanılan aramanın ekran görüntüsü.

Eklenti Türü'nü ayarladıktan sonra, doğru sonuçların döndürülürken doğru olduğunu doğrulamak için özel API'nizi test edebilirsiniz.

Özel API'ler oluşturmanın diğer yolları

Eklenti kayıt aracı özel bir API tasarımcısı sağlar. Daha fazla bilgi için bkz. Eklenti kayıt aracını kullanarak özel API oluşturma.

Tasarımcı dışında özel API'lerin oluşturulmasına izin veren bir istemci uygulaması oluşturma gereksinimleriniz olabilir. Özel API'lerin verileri tablolarda depolandığından, bunları kod kullanarak oluşturabilirsiniz. Daha fazla bilgi için bkz. Kodla özel API oluşturma.

Çözüm dosyalarını düzenleyerek özel API'ler oluşturarak ALM işleminiz daha iyi kullanılabilir. Daha fazla bilgi için bkz. Çözüm dosyalarıyla özel API oluşturma.

Ayrıca bakınız

Özel API'ler oluşturma ve kullanma
Eklenti kayıt aracını kullanarak özel API oluşturma
Kodla özel API oluşturma
Çözüm dosyalarıyla özel API oluşturma
Kendi iletilerinizi oluşturma

  • Last updated on