Create a custom proxy page for the cross-domain library in SharePoint
Learn how to create a custom proxy page to access data in a remote service from a SharePoint webpage by using the cross domain library in SharePoint.
Note The name "apps for SharePoint" is changing to "SharePoint Add-ins". During the transition, the documentation and the UI of some SharePoint products and Visual Studio tools might still use the term "apps for SharePoint". For details, see New name for apps for Office and SharePoint.
When you are building SharePoint Add-ins, you usually have to incorporate data from various sources. However, for security reasons, there are blocking mechanisms that prevent communication with more than one domain at a time.
You can use the cross-domain library to access data in your remote add-in if you provide a custom proxy page that is hosted in the remote add-in infrastructure. As the developer, you are responsible for implementing the custom proxy page, and have to deal with custom logic, such as the authentication mechanism to the remote add-in. Use the cross-domain library with a custom proxy page if you want the communication to occur at the client level.
Prerequisites for using the examples in this article
You need a development environment as explained in Get started creating provider-hosted SharePoint Add-ins.
Core concepts to know before using a custom proxy page with SharePoint Add-ins
The following table lists some useful articles that can help you understand the concepts involved in a cross-domain scenario for SharePoint Add-ins.
Table 1. Core concepts for using a custom proxy page
|SharePoint Add-ins||Learn about the new add-in model in SharePoint that enables you to create add-ins, which are small, easy-to-use solutions for end users.|
|Secure data access and client object models for SharePoint Add-ins||Learn about data access options in SharePoint Add-ins. This topic provides guidance on the high-level alternatives you have to choose from when working with data in your add-in.|
|Host webs, add-in webs, and SharePoint components in SharePoint||Learn about the difference between host webs and add-in webs. Find out which SharePoint components can be included in a SharePoint Add-in, which components are deployed to the host web, which components are deployed to the add-in web, and how the add-in web is deployed in an isolated domain.|
|Client-side Cross-domain Security||Explore cross-domain threats and use cases, and security principles for cross-origin requests, and weigh the risks for developers to enhance cross-domain access from web applications that run in the browser.|
Code example: Access remote data using a custom proxy page for the cross-domain library
To read data from the remote service, you must do the following:
Create a SharePoint Add-in project.
Modify the add-in manifest to allow communication from the remote add-in.
Create the custom proxy page and a content page in the web project.
Create a page that uses the cross-domain library in the SharePoint Add-in project.
To create the SharePoint Add-in project
Open Visual Studio as administrator. (To do this, right-click the Visual Studio icon on the Start menu, and choose Run as administrator.)
Create the provider-hosted SharePoint Add-in as explained in Get started creating provider-hosted SharePoint Add-ins and name itProxyPageApp.
To edit the add-in manifest file
In Solution Explorer, right-click the AppManifest.xml file, and choose View code.
Replace the entire AppPrincipal element with the following.
<AppPrincipal> <Internal AllowedRemoteHostUrl="~remoteAppUrl"/> </AppPrincipal>
**Note** The **AllowedRemoteHostUrl** attribute is used to specify the remote domain. The **~remoteAppUrl** resolves to the remote add-in URL. For more information about tokens, see [Explore the app manifest structure and the package of a SharePoint Add-in](explore-the-app-manifest-structure-and-the-package-of-a-sharepoint-add-in.md).
To create a custom proxy page
After the Visual Studio solution has been created, right-click the web application project (not the SharePoint Add-in project) and add a new Web Form by choosing Add > New Item > Web > Web Form. Name the form Proxy.aspx.
Extracts the add-in web URL from the referrer.
Provides settings for the RequestExecutorMessageProcessor object.
Initializes the RequestExecutorMessageProcessor object.
**Important** In a production SharePoint Add-in, you must provide the authorization logic and return the appropriate value in the **originAuthorityValidator** object in settings.
To create a content page
Right-click the web application project in Solution Explorer and add a new Web Form by choosing Add > New Item > Web > Web Form. Name the form Content.aspx..
Copy the following code and paste it in the Page_Load method in the code-behind file. The code performs the following tasks:
- Sets the output content-type to text/plain.
Writes the content to the output buffer.
Ends the connection.
string content; content = "Just some text."; Response.ContentType="text/plain"; Response.Write(content); Response.End();
To create a SharePoint webpage that uses the cross-domain library
Right-click the SharePoint Add-in project, and choose Add > New Item > Office/SharePoint > Module.
Name the module Pages, and then choose Add.
Right-click the Pages folder and choose Add > New Item> Office/SharePoint > Page.
Name the page Home.aspx and then choose Add.
Open the Home.aspx page if it isn't opened automatically.
Copy the following code and paste it in the PlaceHolderMain content tag.
In the preceding code that you pasted, find the line
remotedomain = "<your_remote_add-in_domain>";, and replace the placeholder <your_remote_add-in_domain> with the "localhost" URL that your web application uses when you are running the add-in with F5 in Visual Studio. To find this value, select the web application project in Solution Explorer. The URL property will be in the Properties pane. Use the entire value, including the protocol, the port, and the closing slash; for example "http://localhost:45072".
Save and close the file.
Open the appmanifest.xml file, and set the Start page value to ProxyPageApp/Pages/Home.aspx.
To build and run the solution
Make sure that the SharePoint Add-in project is set as the startup project.
Press the F5 key.
Note When you press F5, Visual Studio builds the solution, deploys the add-in, and opens the permissions page for the add-in.
Choose the Trust It button.
The Home page will open and it should look like the following. It may take a few seconds for the phrase "Just some text" to appear because it is being fetched from the remote domain's Content.aspx page.
**Data from the remote service in a SharePoint webpage**
Table 2. Troubleshooting the solution
|Visual Studio does not open the browser after you press the F5 key.||Set the SharePoint Add-in project as the startup project.|
|Unhandled exception SP is undefined.||Make sure that you can access the SP.RequestExecutor.js file in a browser window.|
This article demonstrated how to access remote data by using a custom proxy page for the cross-domain library in SharePoint. As a next step, you can learn about other data access options available in SharePoint Add-ins. To learn more, see the following: