A widget allows you to integrate Nearmap content with third party applications. To provide access to Nearmap content within an application such as ArcGIS or a CAMA system, your account administrator needs to create a widget in MyAccount with support from the owner of the system with which you want to integrate (host system).
The configuration involves:
- Creating a widget
- Selecting an integration type.
- Specifying the URL where the widget will be hosted.
- Selecting a subscription.
You access the widget by logging into your system.
NOTE: A widget can only be associated with a single subscription. If you want different subscriptions to be used, you will need to create a widget for each subscription. You can create multiple widgets for a single subscription. Any user with access to the host system will have access to the widget that's integrated.
Creating a Widget
Only accounts that have been provisioned with the Nearmap Widget will be able to create a widget in MyAccount, and only the account administrator will have access to the Widgets tab.
- Click Integrations. If you do not see the tab, it is likely that you are not a Nearmap administrator.
- Click Widgets.
- Click SET UP NEW WIDGET. The Widget Setup dialog is displayed.
- Complete the following:
- Widget Name: Assign any name you want for the widget. The name of each Widget can be a maximum of 100 characters and must be unique.
- Widget integration type: There are two types of integration mechanisms - Signed URL and ArcGIS Token. While Signed URL requires an origin URL, ArcGIS Token requires users to have ArcGIS credentials and can only be created via the Unique Widget Setup URL.
- Select Signed URL to allow users without credentials to access the widget. Use this method for creating a Rapid Appraisal widget.
- Origin URL(s): Enter the location URL or IP address where the widget will be hosted, typically, a named URL or IP address. You can enter multiple URLs if you want to use the same widget within different host systems.
- Select ArcGIS Token to use the customer's ArcGIS credentials to access the widget. Use this method to create a Nearmap Sync widget.
- ArcGIS Sharing API Root URL: This is automatically populated via the Unique Widget Setup URL when you create and register a widget in ArcGIS Enterprise ExperienceBuilder (Developer Edition).
NOTE: If you are using webadaptor or loadbalancer, check that it's included in the URL.
- Subscription: Select the subscription to be associated with this instance of the Widget. Note that you can create as many widgets as you want and associate each with a different subscription. Subscriptions can be changed at any time for existing ArcGIS widgets
- Click NEXT. The Widget Setup dialog box is displayed.
- If you selected Signed URL in Step 4, you'll see the Unique Widget URL and Client Signing Key that are automatically generated along with other details specified for the Widget. Click DONE. See Test the signed URL for instruction to test the URL.
- If you selected ArcGIS token, you'll see the unique Widget URL along with the ArcGIS Sharing API Root URL you specified and the selected subscription. Close the dialog, or click EDIT WIDGET SETUP if you want to change the details you have specified.