sp-dev-fx-webparts/samples/react-3rd-party-api
Hugo Bernier 8e6bd1404b Added web part to every sample 2024-04-18 01:51:29 -04:00
..
.devcontainer added remaining containers 2022-02-16 21:47:07 -05:00
Server-API/SharePoint.PnP.SampleRESTAPI Bump jQuery 2023-06-05 14:20:44 +00:00
assets Added web part to every sample 2024-04-18 01:51:29 -04:00
config Sample client-side web part to consume a 3rd party API from within SharePoint Framework (#424) 2018-02-26 09:14:30 +01:00
images Sample client-side web part to consume a 3rd party API from within SharePoint Framework (#424) 2018-02-26 09:14:30 +01:00
src/webparts/customApiConsumer Sample client-side web part to consume a 3rd party API from within SharePoint Framework (#424) 2018-02-26 09:14:30 +01:00
.editorconfig Sample client-side web part to consume a 3rd party API from within SharePoint Framework (#424) 2018-02-26 09:14:30 +01:00
.gitignore Sample client-side web part to consume a 3rd party API from within SharePoint Framework (#424) 2018-02-26 09:14:30 +01:00
.yo-rc.json Sample client-side web part to consume a 3rd party API from within SharePoint Framework (#424) 2018-02-26 09:14:30 +01:00
README.md Updated contributors for readmes 2023-03-15 00:11:27 -04:00
gulpfile.js Sample client-side web part to consume a 3rd party API from within SharePoint Framework (#424) 2018-02-26 09:14:30 +01:00
notes.txt Sample client-side web part to consume a 3rd party API from within SharePoint Framework (#424) 2018-02-26 09:14:30 +01:00
notes2.txt Sample client-side web part to consume a 3rd party API from within SharePoint Framework (#424) 2018-02-26 09:14:30 +01:00
package.json Sample client-side web part to consume a 3rd party API from within SharePoint Framework (#424) 2018-02-26 09:14:30 +01:00
tsconfig.json Sample client-side web part to consume a 3rd party API from within SharePoint Framework (#424) 2018-02-26 09:14:30 +01:00

README.md

Consuming Third Party APIs secured with Azure Active Directory within SharePoint Framework

Summary

This sub folder contains a client-side project that shows how to consume a 3rd party API within SharePoint Framework.

The UI of the sample application

In subfolder Server-API you can find the sample REST API built using ASP.NET MVC. You will need to publish the web application on a hosting environment (for example an Azure App Service), configure CORS, and configure the application in the Azure AD tenant under the cover of your target SharePoint Online tenant.

Contributors

Version history

Version Date Comments
1.0.0 February 19th 2018 Initial release

Build and run the sample

To build and run this client-side project, you will need to clone and build the tutorials project.

Clone this repo by executing the following command in your console:

git clone https://github.com/pnp/sp-dev-fx-webparts.git

Navigate to the cloned repo folder which should be the same as the repo name:

cd sp-dev-fx-webparts

Navigate to the tutorials folder:

cd tutorials

Navigate to the specific web part folder:

cd 'subfolder'

Now run the following command to install the npm packages:

npm install

This will install the required npm packages and dependencies to build and run the client-side project.

Once the npm packages are installed, run the command to preview your web parts in SharePoint Workbench:

gulp serve

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.