Skip to content

Commit

Permalink
Merge branch 'main' of github.com:box/developer.box.com
Browse files Browse the repository at this point in the history
  • Loading branch information
SowaProgramuje committed Nov 8, 2024
2 parents 8a456a8 + 184cb05 commit 31b01e4
Show file tree
Hide file tree
Showing 74 changed files with 895 additions and 558 deletions.
2 changes: 1 addition & 1 deletion content/guides/applications/app-types/custom-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ A Custom App is best used when the application:
- Wants to use [OAuth 2.0][oauth2], [JWT][jwt] or [Client Credentials Grant][cc] for authentication.
- Wants to upload and download files
- Wants the freedom to access both their own files, as well as files owned by [managed or external users][users].
- Wants the option to list the application in the Box App Center
- Wants the option to list the application in the Box Integrations
- Wants to provide integration into the Box Web App

## Use cases
Expand Down
2 changes: 1 addition & 1 deletion content/guides/applications/app-types/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ create.

| Application Type | Authentication Methods |
| ----------------------------- | ------------------------------------------------------------------- |
| [Custom App][custom-apps] | [OAuth 2.0][oauth2], [JWT][jwt], or [Client Credentials Grant][ccg] |
| [Platform App][custom-apps] | [OAuth 2.0][oauth2], [JWT][jwt], or [Client Credentials Grant][ccg] |
| [Limited Access App][laa] | [App Token][apptoken] |
| [Custom Skill][custom-skills] | No selection needed |

Expand Down
2 changes: 1 addition & 1 deletion content/guides/applications/app-types/select.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You cannot change this selection later on.
| | |
| -------------------------- | ---------------------------------------------------------------------------- |
| **Authentication methods** | [OAuth 2.0][oauth2], [JWT][jwt], or [Client Credentials Authentication][ccg] |
| **Notable Features** | Webhooks, App Center, and Web App Integrations |
| **Notable Features** | Webhooks, Integrations, and Web App Integrations |

Custom App encompasses most use cases and is the most flexible option.
This application type allows for interaction with our 150+ endpoints.
Expand Down
Binary file removed content/guides/applications/images/my-apps-page.png
Binary file not shown.
12 changes: 5 additions & 7 deletions content/guides/applications/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,33 +13,31 @@ alias_paths:

Box Developer Console allows you to create applications
you can then use to integrate with Box.
**My Apps** view displays a list of already created applications
**My Platform Apps** view displays a list of already created applications
and gives you quick access to their configuration details.
This way, you don't need to open
the app each time you want to generate
a Developer Token, copy the Client ID, or generate a report.

![My apps](./images/my-apps-page.png)

## Features

**My Apps** page allows you to:
**My Platform Apps** page allows you to:

* Search through the list of already created apps.
* Filter the apps by **Enablement Status** and **Authentication Type**.
* Create [a new app][select].
* Copy the app's [Client ID][clientcredentials].
* Rename the app and access its details with one click.
* Check application [enablement][enablement] and [authorization][authorization] status. Apps published to App Center display status from App Center.
* Check application [enablement][enablement] and [authorization][authorization] status. Apps published to Integrations display status from Integrations.

The **Options menu** available for every entry allows you to:

* Access the configuration details of your application.
* Generate a [Developer Token][token].
* Add collaborators to your application.
* Run the [App Diagnostics Report][report].
* Run the [Platform App Diagnostics Report][report].

## App Insights
## Platform App Insights

Admins and co-admins can access the Platform Insights
dashboard that provides a comprehensive
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ alias_paths:
- /guides/applications/app-gallery/
---

# App Center
# Integrations

The [Box App Center][app-center] is the first place for Box users to find out
The [Box Integrations][app-center] is the first place for Box users to find out
about applications that they can use in combination with Box. If your
application is suited to be used by other enterprises, listing your service in
the App Center can be a great way to find new users.
App center groups apps into sections so that you can
the Integrations can be a great way to find new users.
Integrations groups apps into sections so that you can
quickly find featured, most popular, or recently added apps.

<ImageFrame shadow center>
![App Center](./images/app-center.png)
![Integrations](./images/app-center.png)
</ImageFrame>

## Developing and app or becoming a Box Partner
Expand All @@ -41,20 +41,20 @@ Center][app-center].
Your application must meet the following requirements:

* The application is in a finished state and ready for production usage.
* The application leverages OAuth 2.0 authentication, as the App Center does not support any other authentication methods.
* The application leverages OAuth 2.0 authentication, as the Integrations does not support any other authentication methods.
* You are a developer with access to the application in the [Developer Console][devconsole].

### 1. Log in to the Developer Console

Navigate to the [Developer Console][devconsole] and select your application to
submit to the App Center.
submit to the Integrations.

### 2. Fill in the form

Select the **App Center** tab from the top menu.
Select the **Integrations** tab from the top menu.

<ImageFrame center border shadow>
![App Center panel](./images/app-center.png)
![Integrations panel](./images/app-center.png)
</ImageFrame>

Click the button to "Submit My App".
Expand Down Expand Up @@ -93,7 +93,7 @@ Approval" button.

Once approved and published, an application can be unpublished from the same
control panel. Navigate to the [Developer Console][devconsole] and select
your application. Then, select the "App Center" panel from the left-hand
your application. Then, select the "Integrations" panel from the left-hand
sidebar. The app can be unpublished from this page.

[app-center]: https://app.box.com/services
Expand Down
12 changes: 6 additions & 6 deletions content/guides/applications/web-app-integrations/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ related_endpoints: []
related_guides:
- authentication/oauth2/oauth2-setup
- authentication/tokens
- applications/app-center
- applications/integrations
required_guides: []
related_resources: []
alias_paths: []
Expand Down Expand Up @@ -47,7 +47,7 @@ To configure the integration, follow the guidance below for each value.
| Field | Description |
|--------------------------- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Integration name | The name of your integration, which users see in the Box Web App when they select the **More Options** > **Integrations** menu on a file or folder. |
| Description | The description of the integration displayed in the Box App Center. |
| Description | The description of the integration displayed in the Box Integrations. |
| Supported file extensions | The integration will only appear as an option in the **More Options** > **Integrations** menu for the selected file extensions. |
| Permissions requirement | Determines what permissions level users need to see the integration. **Download permissions are required** allows users to download the file - they will not be able to update it. **Full permissions are required** allows users to download and update the file. |
| Integration scopes | Specifies the scope of your integration - either the file/folder from which integration is invoked, or its parent folder. |
Expand Down Expand Up @@ -95,8 +95,8 @@ The following parameter values are available.
### Integration Status

- **Development**: The integration is visible and available only to application collaborators listed under the **General Settings** tab. This option is best used when the application is still in development and undergoing testing.
- **Online**: The integration is visible and available to all Box users. This option is best used when development is complete and the application is ready to publish in the App Center.
- **Maintenance**: The integration is visible and available only to application collaborators listed under the **General Settings** tab. This option is best used after the integration is published in the App Center, but needs to perform maintenance updates or troubleshoot issues. Use this option to temporarily take the integration offline for everyone except the application's collaborators.
- **Online**: The integration is visible and available to all Box users. This option is best used when development is complete and the application is ready to publish in the Integrations.
- **Maintenance**: The integration is visible and available only to application collaborators listed under the **General Settings** tab. This option is best used after the integration is published in the Integrations, but needs to perform maintenance updates or troubleshoot issues. Use this option to temporarily take the integration offline for everyone except the application's collaborators.

## Example Use Cases of Box Integrations

Expand Down Expand Up @@ -139,7 +139,7 @@ note that the URL must be publicly accessible on the internet.
## Making Integration Publicly Available

To make a Box integration publicly available it needs to be listed in the App
Center. Follow the [App Center][app-center] guide for more details.
Center. Follow the [Integrations][integrations] guide for more details.

[ca]: g://applications/app-types/custom-apps
[pu]: g://applications/web-app-integrations/types
Expand All @@ -149,4 +149,4 @@ Center. Follow the [App Center][app-center] guide for more details.
[custom-oauth2]: g://authentication/oauth2/oauth2-setup
[devconsole]: https://app.box.com/developers/console
[devaccount]: https://account.box.com/signup/n/developer
[app-center]: g://applications/app-center
[integrations]: g://applications/integrations
6 changes: 3 additions & 3 deletions content/guides/applications/web-app-integrations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ when editing or sharing files.

Using a Web App Integration, a user can modify, share, or edit content stored in
Box using a third-party application. It can also offer new features to Box users
through [Recommended Apps][recommended-apps], which show up in Box Preview.
through [Recommended Web Integrations][recommended-web-integrations], which show up in Box Preview.

<ImageFrame border shadow width='600' center>
![Integration example](./images/recommended-apps-preview.png)
Expand All @@ -34,10 +34,10 @@ restricted to certain content types and file extensions.
Learn how to create a Web App Integration
</CTA>

[app-center]: g://applications/app-center
[integrations]: g://applications/integrations
[custom-app]: g://authentication/oauth2/oauth2-setup
[oauth2]: g://authentication/oauth2
<!-- i18n-enable localize-links -->
[devconsole]: https://app.box.com/developers/console
[recommended-apps]: https://support.box.com/hc/en-us/articles/360044195533-Installing-Recommended-Apps-in-your-Enterprise
[recommended-web-integrations]: https://support.box.com/hc/en-us/articles/360044195533-Installing-Recommended-Apps-in-your-Enterprise
<!-- i18n-disable localize-links -->
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ alias_paths: []
The following explains what a Web App Integration looks like from a user's point
of view.

1. Box users can discover applications in the Box App Center. They can visit the App Center directly, or select the **Apps** menu from the Box Web App UI.
2. In the App Center they select the application they would like to add. Every published Box application has a public profile page, which provides details including the integrations it provides.
3. They user adds the application to their account by clicking the **Add** button in the App Center listing. Once an application is added to an account, all its integrations become available to the user.
1. Box users can discover applications in the Box Integrations. They can visit the Integrations directly, or select the **Integrations** menu from the Box Web App UI.
2. In the Integrations they select the application they would like to add. Every published Box application has a public profile page, which provides details including the integrations it provides.
3. They user adds the application to their account by clicking the **Add** button in the Integrations listing. Once an application is added to an account, all its integrations become available to the user.
4. Select an integration from the **More Actions** menu on a file or folder.
5. Box will ask the user for permission to share the file or folder with the application. The confirmation prompt must accepted before the integration can be successfully used.
6. Upon granting access, Box passes the data to the application. Depending on the type of integration, the application will then display a popup panel or run a server-based process.
6 changes: 3 additions & 3 deletions content/guides/authentication/app-token/app-token-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ for authentication.

## Prerequisites

To set up a Custom App using server-side authentication, you will need to ensure
To set up a Platform App using server-side authentication, you will need to ensure
you have access the [Developer Console][devconsole] from your Box enterprise
account. Alternatively, you may sign up for a [developer account][devaccount].

Expand All @@ -35,9 +35,9 @@ account. Alternatively, you may sign up for a [developer account][devaccount].
### 1. Log in to the Developer Console

Log into Box and navigate to the [Developer Console][devconsole].
Select **Create New App**.
Select **Create Platform App**.

### 2. Create a Custom App
### 2. Create a Platform App

Select **Limited Access App** from the list of application types.
A modal will appear to prompt the next step.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ account. Alternatively, you may sign up for a [developer account][devaccount].
### Navigate to the Developer Console

Log into Box and go to the [Developer Console][devconsole].
Select **Create New App**.
Select **Create Platform App**.

### Select application type

Expand Down
14 changes: 7 additions & 7 deletions content/guides/authentication/jwt/jwt-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ alias_paths:

# Setup with JWT

A Custom App can be set up to use server-side authentication with
A Platform App can be set up to use server-side authentication with
[JWT][jwt].

<CTA to='g://authentication/jwt'>
Expand All @@ -27,7 +27,7 @@ A Custom App can be set up to use server-side authentication with

## Prerequisites

To set up a Custom App using server-side authentication, you will need to ensure
To set up a Platform App using server-side authentication, you will need to ensure
you have access the [Developer Console][devconsole] from your Box enterprise
account. Alternatively, you may sign up for a [developer account][devaccount].

Expand All @@ -36,11 +36,11 @@ account. Alternatively, you may sign up for a [developer account][devaccount].
### Navigate to the Developer Console

Log into Box and go to the [Developer Console][devconsole].
Select **Create New App**.
Select **Create Platform App**.

### Select application type

Select **Custom App** from the list of application types. A modal will appear to
Select **Platform App** from the list of application types. A modal will appear to
prompt a selection for the next step.

<ImageFrame border>
Expand All @@ -65,7 +65,7 @@ Use the drop-down list to select the app's purpose. Depending on the option chos
### Select application authentication

Select **Server Authentication (with JWT)** if you would like to verify
application identity [with a key pair][kp] and confirm with **Create App**.
application identity [with a key pair][kp] and confirm with **Create Platform App**.

<Message warning>
Once you make a selection, you will not be able to change to a different
Expand All @@ -83,7 +83,7 @@ authentication method without creating a new application.
(Client Credentials Grant) as your authentication method.
</Message>

Once a Custom App is created leveraging Server Authentication with JWT, a key
Once a Platform App is created leveraging Server Authentication with JWT, a key
pair can be generated via the configuration tab within the
[Developer Console][devconsole]. Alternatively, you can generate your
own and supply Box with the public key. Regardless of the method you select,
Expand Down Expand Up @@ -160,7 +160,7 @@ approval. More information on this process is available in our
[support article for app authorization][app-auth].

<CTA to='g://authorization/custom-app-approval'>
Learn how to authorize a Custom Application
Learn how to authorize a Platform Application
</CTA>

## Basic configuration
Expand Down
2 changes: 1 addition & 1 deletion content/guides/authentication/oauth2/oauth2-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ account. Alternatively, you may sign up for a [developer account][devaccount].
### Navigate to the Developer Console

Log into Box and go to the
[Developer Console][devconsole]. Select **Create New App**.
[Developer Console][devconsole]. Select **Create Platform App**.

### Select application type

Expand Down
4 changes: 2 additions & 2 deletions content/guides/authentication/tokens/developer-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ To create a Developer Token for an application:
- Under Developer Token, select **Generate Developer Token**.

<Message>
You can also generate a Developer Token directly from [My Apps][apps] view,
using the menu available for each app.
You can also generate a Developer Token directly from [My Platform Apps][apps]
view, using the menu available for each app.
</Message>

<ImageFrame border center shadow>
Expand Down
2 changes: 1 addition & 1 deletion content/guides/authentication/tokens/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ with content the user associated with the Access Token either a collaborator on
or owns. This can be further restricted by [downscoping][ds] a token.

<Message warning>
Application scopes, application access, enabled advanced settings, user
Required access scopes, application access, enabled advanced settings, user
permissions, and endpoint-specific restrictions all work together to determine
which API calls will be successful. For example, even if a user has
collaborator access to a folder, a call to get information about the folder
Expand Down
14 changes: 7 additions & 7 deletions content/guides/authorization/custom-app-approval.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ A Box Admin needs an application's Client ID in order to properly
authorize or enable it in the Admin Console.

<Message>
You can use [My Apps][apps] view to quickly look up
You can use [Integrations][apps] view to quickly look up
the authorization and enablement status of your application.
</Message>

Expand Down Expand Up @@ -67,7 +67,7 @@ application.
2. Scroll down to the OAuth 2.0 Credentials section and copy the **Client ID** value to provide to a Box Admin.

Alternatively, hover over the application in the
[My Apps][apps] view to look up the **ClientID** and then
[My Platform Apps][apps] view to look up the **ClientID** and then
copy it using the `copy` button.

<Message>
Expand All @@ -80,15 +80,15 @@ copy it using the `copy` button.

### As an Admin

1. Navigate to the [Admin Console][adminconsole] and select the **Apps** tab (1) from the left navigation panel.
2. Click the **Custom Apps Manager** tab (2) at the top of your screen.
3. For both Server and User Authentication Apps screens, click the **Add App** (3) button in the top right corner to add a new app.
4. Alternatively, you can use the Custom Apps Manager table menu (4) to authorize and enable apps.
1. Navigate to the [Admin Console][adminconsole] and select the **Integrations** tab (1) from the left navigation panel.
2. Click the **Platform Apps Manager** tab (2) at the top of your screen.
3. For both Server and User Authentication Apps screens, click the **Add Platform App** (3) button in the top right corner to add a new app.
4. Alternatively, you can use the Platform Apps Manager table menu (4) to authorize and enable apps.

#### Server Authentication Apps

<ImageFrame border center>
![Server Apps tab](images/jwt_app_approval_flow.png)
![Server tab](images/jwt_app_approval_flow.png)
</ImageFrame>

#### User Authentication Apps
Expand Down
Loading

0 comments on commit 31b01e4

Please sign in to comment.