Prerequisites
Access to the Developer Console.Create a Platform App
- Navigate to the Developer Console.
- Select Create Platform App.
- Provide a name for your app.
- Select the authentication method you want to use.
- Click Create App.
Configure application settings
After you create a Platform App, the settings screen is displayed.General settings
- App Name - the name you set up during the app creation, you can change it here if needed.
- App Description - provide a description for your app (optional).
- Contact Email - this is set to the developer of the application by default. Keep in mind that once you publish your app, this email is publicly visible to Box users who view your app in the Integrations. We recommend to change it to a support email address, so that users can reach out to support in case of any issues with the integration.
Configuration
- Purpose - select the purpose of your app from the drop-down list. Depending on the option you choose, you might need to specify further details.
| Purpose | Details |
|---|---|
| Automation, Custom Portal | Specify if the app is built by a customer or partner. |
| Integration | Specify the integration category, external system name if you’re integrating with one, and if the app is built by a customer or partner. |
| Other | Specify the app purpose and if it is built by a customer or partner. |
- Authentication Method - choose how your app will authenticate to the Box APIs.
| Authentication Method | Details |
|---|---|
| OAuth 2.0 | Specify the client ID and client secret. |
| JWT | Add a public key or generate a public/private key pair. Choose the app access level. |
| Client Credentials Grant | Specify the client ID and client secret. Choose the app access level. |
- Developer Token - a developer token is created automatically when you create a Platform App.
- Application Scopes - choose the scopes you want to grant to your app. See the scopes guide for detailed information on each option.
- Advanced Features - enable the advanced features your application requires.
- CORS Domains - add the domains you want to allow requests from.
