Add and register an app

Along with adding files as items to a portal, you can add and register apps using the portal service. You add apps to a portal when you want to:

• Increase app accessibility to organization members and the public.
• Control app access enabling you to specify sharing privileges.
• Collect usage statistics.

There are two ways of adding an application to the portal:

• Add an app from a URL.
• Add and register an app using developer credentials.

Add an app from a URL

Adding an app from a URL is a process for sharing your work with members of your organization. In addition to sharing the URL, you can include details about the app, purpose, and providing a summary. By adding these details, you can convey the capabilities your app to a wider audience.

Examples

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
            var portal = new Portal();

            // Load the portal
            portal.load().then(function() {
                // Create a new PortalItem
                var newItem = new PortalItem({
                    portal: portal,
                    type: "Web Mapping Application", // Change this to match the type of your web app
                    title: "Your Web App Title", // Change this to match the title of your web app
                    url: "URL_TO_YOUR_WEB_APP" // Change this to match the URL of your web app
                });

                // Add the new item to ArcGIS Online
                portal.user.addItem(newItem)
                .then(function() {
                    console.log("Web app added successfully!");
                });

Add and register an app using developer credentials

Adding a registered app involves adding and registering apps with either ArcGIS Online or ArcGIS Enterprise to generate an app ID. This app ID is used in the app to collect usage statistics and enable users to sign in to the portal using OAuth 2.0.

By registering an OAuth app, you require users to sign in through a portal hosted login page. This process enables apps to access content in their organization and use various ArcGIS Online or ArcGIS Enterprise services like Geocoding, Routing and GeoEnrichment.

Registered vs unregistered app

A registered app offers:

• Full integration with ArcGIS Online or ArcGIS Enterprise.
• Advanced features like using ready-to-use services.
• Better control over user access.

The table below details the differences between a registered and unregistered app:

Developer credentials

Developer credentials is a set of credentials, typically a client ID and client secret, that are used by an application to obtain a short-lived access token. These credentials are essential for authentication and authorization processes in ArcGIS. Developer credentials play a role in app authentication where the credentials authorize an application to access ready-to-use services. The access token obtained through developer credentials is associated with a developer's ArcGIS account and enables access to various location services.

Examples

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Replace these variables with your developer credentials and app details
client_id = "YOUR_CLIENT_ID"
client_secret = "YOUR_CLIENT_SECRET"
app_title = "Your App Title"
app_type = "Web Mapping Application"  # Change if your app type is different
app_url = "URL_TO_YOUR_WEB_APP"  # Replace with your app's URL

# Create a GIS object with developer credentials
gis = GIS(client_id=client_id, client_secret=client_secret)

# Access the content manager
content_mgr = gis.content

# Create a new item representing the app
app_item_properties = {
    "type": app_type,
    "title": app_title,
    "url": app_url
}
app_item = content_mgr.add(app_item_properties)

Services

API support

Tools

Use tools to access the portal and create and manage content for applications.