How to expose Nintex Mobile through your firewall

QUESTION
In this article we explain how Nintex Mobile communicates to a Nintex Forms for SharePoint installation. If your SharePoint environment is not accessible outside your private network and you want to enable external access for Nintex Mobile, please consider the following information when identifying the best approach for your organization e.g. tunneling access through your firewall or creating a VPN.
ANSWER
Service Endpoints
Nintex Forms for SharePoint ships with two service endpoints that can be used by Nintex Mobile.  The endpoints provide identical functionality, with only one difference: one endpoint has been designed to operate in a Forms-based Authentication (FBA) SharePoint environment.  For more information on enabling FBA support, please see the Nintex Mobile help files.

 

The following table lists the different service endpoints:
 
Friendly Name Location
Windows Authentication Service https://{server}/_vti_bin/NintexFormsServices/NfMobileAppService.svc
Forms Based Authentication Service https://{server}/_vti_bin/NintexMobile/FBA/NfMobileFbaAppService.svc
 
NOTE: Before you can use the FBA endpoint, you must ensure that you have already configured FBA in your SharePoint environment. 
 
API Endpoints
API endpoints are the individual calls made by Nintex Mobile through the service endpoint to send and receive data.
The following table lists the API endpoints called by Nintex Mobile:
 
Friendly Name Location HTTP Method
Get Forms https://{server}/{service-endpoint}/forms GET
Get Form Definition https://{server}/{service-endpoint}/forms/{id} GET
Get Tasks https://{server}/{service-endpoint}/tasks GET
Get Tasks Attachments https://{server}/{service-endpoint}/tasks/attachments GET
Get Task Definition https://{server}/{service-endpoint}/tasks/{id} GET
Forms/Task Icons https://{server}/{service-endpoint}/Resource{id} GET
List Lookup Data https://{server}/{service-endpoint}/RefData?id={id} GET
People Picker Search https://{server}/{service-endpoint}/SearchEntities/{search} GET
Form Submission https://{server}/{service-endpoint}/forms/{id} POST
Task Submission https://{server}/{service-endpoint}task/{id} POST
 
User Agent
When Nintex Mobile communicates to your SharePoint environment, it uses the following user agent values:
Platform Device Type User Agent
Android Phone nintex-mobile-ap
Tablet nintex-tablet-at
iOS Phone nintex-mobile-iphone
Tablet nintex-table-ipad
Windows Mobile nintex-mobile-wp
PC nintex-tablet-win
ADDITIONAL INFORMATION
Outside the documented endpoints that Nintex Mobile communications with, Nintex Mobile will make direct calls to external servers for the following controls:
  • Image
  • Page Viewer
This behavior is by design and is a function of the controls.

 

NOTE: In this article all we have prefixed all URLs with HTTPS.  While Nintex recommends that all communication between Nintex Mobile and your SharePoint environment occurs over a secure channel, it is not a requirement.
RELATED LINKS
Version history
Revision #:
3 of 3
Last update:
‎11-18-2020 09:02 AM
Updated by:
 
Contributors