cancel
Showing results for 
Search instead for 
Did you mean: 
Reply
SumitThakran
Helper I
Helper I

Best way to consume External Rest API in PCF Control

Hi All,

 

I have built one sub grid control using Typescript and React JS in Powerapp Control Framework.

Now i want to add some action in this subgrid control . On click of these action  , it will rather fetch data from external Rest API or update or create data in external web api too.

 

So kindly suggest me what's best way to do these Rest API operations in Typescript. Also should i consume Rest API operations in Typescript or its better to consume it in DotNet Plugin and call register that plugin on click of these action buttons or is there any better approach ?

 

My Concern here is that as Typescript is deployed finally on client side . So if  i consume Rest API in Typescript and deploy this control on Powerapp environment then it will reside on Client side application not on server side like we consume rest api in DotNet class file and hence client side deployment might create security risks too.

 

Any help or suggestion would be appreciated.

 

 

Thanks

 

1 ACCEPTED SOLUTION

Accepted Solutions

Hi,

TypeScript is basically just JavaScript so there is no way of hiding security details once it is running on the client. Any authentication you use on the client will be discoverable if someone wanted to find it.

 

Calling a custom action via a PCF control is the same way as it would be via a Custom Ribbon Button JavaScript - the only cavate is that Xrm.WebApi.online.execute is not yet documented (and therefore supported) via PCF - but it is there to use if you use just case the Xrm.WebApi to any in Typescript and don't use the PCF provided typings. The alternative supported approach would be to call the WebApi manually using fetch or XMLHttpRequest- see a related discussion here - https://powerusers.microsoft.com/t5/Power-Apps-Pro-Dev-ISV/How-to-call-custom-actions-using-PCF/td-p...

 

Hope this helps!

View solution in original post

11 REPLIES 11
ScottDurow
Memorable Member
Memorable Member

Hi!

It is very common to wrap external API calls inside a Custom Action Plugin - this way your client scripts do not need to have the security information to call the external service.

 

Information on custom actions - https://docs.microsoft.com/en-us/powerapps/developer/common-data-service/custom-actions

Here are the best practices when calling external services in a plugin - https://docs.microsoft.com/en-us/powerapps/developer/common-data-service/access-web-services

 

Hope this helps!

Hi Scott,

 

Thanks for your comment.

 

Yes , i am aware about building custom plugins and then registering those plugins against action in CRM.

This plugin can be triggered on ribbon buttons created using Ribbon workbench tool or any other tool.

But i want to create action buttons inside PCF control not by Ribbon workbench , then would i be able to call or trigger custom plugin from action button in PCF.

 

Also does Typescript not provide any way to hide these external API details not to expose on client side.

 

 

Thanks

 

Hi,

TypeScript is basically just JavaScript so there is no way of hiding security details once it is running on the client. Any authentication you use on the client will be discoverable if someone wanted to find it.

 

Calling a custom action via a PCF control is the same way as it would be via a Custom Ribbon Button JavaScript - the only cavate is that Xrm.WebApi.online.execute is not yet documented (and therefore supported) via PCF - but it is there to use if you use just case the Xrm.WebApi to any in Typescript and don't use the PCF provided typings. The alternative supported approach would be to call the WebApi manually using fetch or XMLHttpRequest- see a related discussion here - https://powerusers.microsoft.com/t5/Power-Apps-Pro-Dev-ISV/How-to-call-custom-actions-using-PCF/td-p...

 

Hope this helps!

Hi Scott,

 

Thanks for your comment.

 

About hiding keys in Typescript ,I searched and found below URL which says about creating .env file in project to hide keys. Is it useful 

https://medium.com/better-programming/how-to-hide-your-api-keys-c2b952bc07e6/

 

Also thanks for mentioning approach for custom Action , i will try to follow on that.

 

Thanks

 

Hi Scott,

 

One More thing, i tried consuming external web api using Fetch in Typescript but its throwing me "Origin blocked by CORS Policy" error. 

How can i overcome such type of error . 

 

Thanks

 

Is this in a model driven app or a canvas app?

Can you post the webapi call code you are using?

Hi Scott,

 

I am building a control and using it in Model Driven apps. On click of control , its hitting external web api and showing its result too.

So Below is line of code i have written for fetching data from external web api in typescript.

 
const FetchResult = await fetch("https://xxxxxxxx").then(.....................
 
Its throwing error CORS Policy error while fetching . I have tried to add mode as "no-cors" but still error is coming.
 
Thanks
 
 

Hi - I think the issue is actually to do with the CORS policy of the service you are calling - it must be configured to accept calls from the domain that you are coming from. What is the external service - check if it supports JSONP - https://medium.com/developers-arena/understanding-json-jsonp-cors-and-bypassing-cors-with-jsonp-fa5f...

Hi Scott,

 

But my external web service is returning result in XML format not in json.

 

 

 

Thanks

 

 

Helpful resources

Announcements

Celebrating the May Super User of the Month: Laurens Martens

  @LaurensM  is an exceptional contributor to the Power Platform Community. Super Users like Laurens inspire others through their example, encouragement, and active participation. We are excited to celebrated Laurens as our Super User of the Month for May 2024.   Consistent Engagement:  He consistently engages with the community by answering forum questions, sharing insights, and providing solutions. Laurens dedication helps other users find answers and overcome challenges.   Community Expertise: As a Super User, Laurens plays a crucial role in maintaining a knowledge sharing environment. Always ensuring a positive experience for everyone.   Leadership: He shares valuable insights on community growth, engagement, and future trends. Their contributions help shape the Power Platform Community.   Congratulations, Laurens Martens, for your outstanding work! Keep inspiring others and making a difference in the community!   Keep up the fantastic work!        

Check out the Copilot Studio Cookbook today!

We are excited to announce our new Copilot Cookbook Gallery in the Copilot Studio Community. We can't wait for you to share your expertise and your experience!    Join us for an amazing opportunity where you'll be one of the first to contribute to the Copilot Cookbook—your ultimate guide to mastering Microsoft Copilot. Whether you're seeking inspiration or grappling with a challenge while crafting apps, you probably already know that Copilot Cookbook is your reliable assistant, offering a wealth of tips and tricks at your fingertips--and we want you to add your expertise. What can you "cook" up?   Click this link to get started: https://aka.ms/CS_Copilot_Cookbook_Gallery   Don't miss out on this exclusive opportunity to be one of the first in the Community to share your app creation journey with Copilot. We'll be announcing a Cookbook Challenge very soon and want to make sure you one of the first "cooks" in the kitchen.   Don't miss your moment--start submitting in the Copilot Cookbook Gallery today!     Thank you,  Engagement Team

Announcing Power Apps Copilot Cookbook Gallery

We are excited to share that the all-new Copilot Cookbook Gallery for Power Apps is now available in the Power Apps Community, full of tips and tricks on how to best use Microsoft Copilot as you develop and create in Power Apps. The new Copilot Cookbook is your go-to resource when you need inspiration--or when you're stuck--and aren't sure how to best partner with Copilot while creating apps.   Whether you're looking for the best prompts or just want to know about responsible AI use, visit Copilot Cookbook for regular updates you can rely on--while also serving up some of your greatest tips and tricks for the Community. Check Out the new Copilot Cookbook for Power Apps today: Copilot Cookbook - Power Platform Community.  We can't wait to see what you "cook" up!      

Tuesday Tip | How to Report Spam in Our Community

It's time for another TUESDAY TIPS, your weekly connection with the most insightful tips and tricks that empower both newcomers and veterans in the Power Platform Community! Every Tuesday, we bring you a curated selection of the finest advice, distilled from the resources and tools in the Community. Whether you’re a seasoned member or just getting started, Tuesday Tips are the perfect compass guiding you across the dynamic landscape of the Power Platform Community.   As our community family expands each week, we revisit our essential tools, tips, and tricks to ensure you’re well-versed in the community’s pulse. Keep an eye on the News & Announcements for your weekly Tuesday Tips—you never know what you may learn!   Today's Tip: How to Report Spam in Our Community We strive to maintain a professional and helpful community, and part of that effort involves keeping our platform free of spam. If you encounter a post that you believe is spam, please follow these steps to report it: Locate the Post: Find the post in question within the community.Kebab Menu: Click on the "Kebab" menu | 3 Dots, on the top right of the post.Report Inappropriate Content: Select "Report Inappropriate Content" from the menu.Submit Report: Fill out any necessary details on the form and submit your report.   Our community team will review the report and take appropriate action to ensure our community remains a valuable resource for everyone.   Thank you for helping us keep the community clean and useful!

Community Roundup: A Look Back at Our Last 10 Tuesday Tips

As we continue to grow and learn together, it's important to reflect on the valuable insights we've shared. For today's #TuesdayTip, we're excited to take a moment to look back at the last 10 tips we've shared in case you missed any or want to revisit them. Thanks for your incredible support for this series--we're so glad it was able to help so many of you navigate your community experience!   Getting Started in the Community An overview of everything you need to know about navigating the community on one page!  Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Community Ranks and YOU Have you ever wondered how your fellow community members ascend the ranks within our community? We explain everything about ranks and how to achieve points so you can climb up in the rankings! Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Powering Up Your Community Profile Your Community User Profile is how the Community knows you--so it's essential that it works the way you need it to! From changing your username to updating contact information, this Knowledge Base Article is your best resource for powering up your profile. Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Community Blogs--A Great Place to Start There's so much you'll discover in the Community Blogs, and we hope you'll check them out today!  Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Unlocking Community Achievements and Earning Badges Across the Communities, you'll see badges on users profile that recognize and reward their engagement and contributions. Check out some details on Community badges--and find out more in the detailed link at the end of the article! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Blogging in the Community Interested in blogging? Everything you need to know on writing blogs in our four communities! Get started blogging across the Power Platform communities today! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Subscriptions & Notifications We don't want you to miss a thing in the community! Read all about how to subscribe to sections of our forums and how to setup your notifications! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Getting Started with Private Messages & Macros Do you want to enhance your communication in the Community and streamline your interactions? One of the best ways to do this is to ensure you are using Private Messaging--and the ever-handy macros that are available to you as a Community member! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Community User Groups Learn everything about being part of, starting, or leading a User Group in the Power Platform Community. Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Update Your Community Profile Today! Keep your community profile up to date which is essential for staying connected and engaged with the community. Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Thank you for being an integral part of our journey.   Here's to many more Tuesday Tips as we pave the way for a brighter, more connected future! As always, watch the News & Announcements for the next set of tips, coming soon!

Hear what's next for the Power Up Program

Hear from Principal Program Manager, Dimpi Gandhi, to discover the latest enhancements to the Microsoft #PowerUpProgram, including a new accelerated video-based curriculum crafted with the expertise of Microsoft MVPs, Rory Neary and Charlie Phipps-Bennett. If you’d like to hear what’s coming next, click the link below to sign up today! https://aka.ms/PowerUp  

Users online (2,692)