Skip to content

Commit 47541ed

Browse files
Merge branch 'main' of github.com:box/developer.box.com
2 parents 335264a + f09304d commit 47541ed

File tree

6 files changed

+57
-70
lines changed

6 files changed

+57
-70
lines changed

.spelling

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -334,4 +334,5 @@ Anthropic
334334
GPT-4o-2024-05-13
335335
text-embedding-ada-002
336336
params
337-
GPT-4o-mini
337+
GPT-4o-mini
338+
unpublish

content/guides/api-calls/api-versioning-strategy.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ To stay informed about the forthcoming API modifications, monitor the [Changelog
1717

1818
</Message>
1919

20-
<!-- Commenting this until we enable base version support in Public API Service
2120
<Message type='notice'>
2221

2322
In 2024, Box introduced year-based API versioning.
@@ -29,7 +28,6 @@ All endpoints available at the end of 2024 were assigned the version `2024.0`.
2928
To make version-aware API calls, include the `box-version` header with the value `2024.0` in your requests.
3029

3130
</Message>
32-
-->
3331

3432
## How Box API versioning works
3533

5.32 KB
Loading

content/guides/applications/integrations/index.md

Lines changed: 29 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -14,60 +14,58 @@ alias_paths:
1414

1515
# Integrations
1616

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

2424
![Integrations](./images/box-integrations.png)
2525

26-
## Developing and app or becoming a Box Partner
26+
## Developing a platform app or becoming a Box Partner
2727

28-
If you would more information on developing an application for the Box Integrations or becoming a Box Partner, visit our [Box Partner Resources][bp] guides on our community site.
28+
If you need more information on developing a platform app for the Box Integrations or becoming a Box Partner, visit our [Box Partner Resources][bp] guides on our community site.
2929

30-
## Publishing an app
30+
## Publishing a platform app
3131

32-
Use the following steps to publish an application in Box Integrations.
32+
Use the following steps to publish a platform app in Box Integrations.
3333

3434
### Prerequisites
3535

3636
Your application must meet the following requirements:
3737

38-
* The application is in a finished state and ready for production usage.
39-
* The application leverages OAuth 2.0 authentication, as the Integrations does not support any other authentication methods.
40-
* You are a developer with access to the application in the [Developer Console][devconsole].
38+
* The platform app is in a finished state and ready for production usage.
39+
* The platform app leverages OAuth 2.0 authentication, as Integrations do not support any other authentication methods.
40+
* You are a developer with access to the platform app in the **Developer Console**.
4141

4242
### Steps
4343

44-
1. Navigate to the [Developer Console][devconsole] and select your application to submit.
44+
1. Navigate to the Developer Console > **My Platform Apps** and select the app you want to publish.
4545
2. Select the **Publishing** tab from the top menu.
4646

47-
![Integrations panel](./images/publishing-app.png)
47+
![Publishing tab for an application](./images/publishing-app.png)
4848

49-
3. Fill in the form with your application's categories, a short and a long description, screenshots and an app icon.
50-
4. Click **Preview** to see a preview of your application listing.
51-
5. Finally, submit the application for approval by clicking the **Submit for Approval** button.
49+
3. Read through the submission checklist and check the confirmation checkbox if your app meets all the requirements.
50+
4. Fill in the form by providing:
5251

53-
<Message>
54-
# Approval completion
52+
* the categories your app falls under
53+
* a short and a long description
54+
* screenshots and an app icon
55+
* supplementary information that will be used to support the users
5556

56-
Once a request for approval is received, the Box Partner team will be
57-
notified and review your request as soon as possible.
57+
5. Use the **Preview** button in the top right corner to see how your application will look when listed.
58+
6. Finally, submit the application for approval by clicking the **Submit for Approval** button. Once a request for approval is received, the Box Partner team will be notified and review your request as soon as possible. For any questions, email [`integrate@box.com`][email].
5859

59-
For any questions, please email [`integrate@box.com`][email] or submit a
60-
support ticket.
61-
</Message>
60+
## Unpublishing a platform app
6261

63-
## Unpublishing an application
62+
Once approved and published, a platform app can be unpublished from the same
63+
control panel:
6464

65-
Once approved and published, an application can be unpublished from the same
66-
control panel. Navigate to the [Developer Console][devconsole] and select
67-
your application. Then, select the **Integrations** panel from the left-hand
68-
sidebar. The app can be unpublished from this page.
65+
1. Navigate to the **Developer Console** and select your platform app.
66+
2. Select the **Publishing** tab.
67+
3. You can now unpublish the app.
6968

7069
[app-center]: https://app.box.com/services
71-
[devconsole]: https://cloud.app.box.com/developers/console
7270
[email]: mailto:integrate@box.com
73-
[bp]: https://support.box.com/hc/en-us/sections/360009473734-Box-Partner-Resources
71+
[bp]: https://support.box.com/hc/en-us/sections/21356597387539-Box-Partner-Programs

content/guides/getting-started/publish-app.md

Lines changed: 22 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,48 +2,38 @@
22
rank: 3
33
---
44

5-
# Publish your application
5+
# Publish your app
66

7-
When you finish the app configuration and testing, you can publish
7+
When you finish the platform app configuration and testing, you can publish
88
it in the [Box Integrations][integrations]. It allows customers to find
9-
your application and add it to their Box accounts.
9+
your app and add it to their Box accounts.
1010

1111
<Message type='warning'>
1212

13-
Only applications that use the OAuth 2.0 authentication have a
14-
built-in publication option. You can use other user authentication
15-
types, but such app can only serve as a marketing listing in the
16-
Integrations and redirect customers to your website.
13+
Only apps that use the OAuth 2.0 authentication have a built-in publication option. In case you use a different auth type for your integration, you can still create and publish an OAuth 2.0 platform app that will serve as a marketing listing in the **Integrations** and redirect customers to your website.
1714

1815
</Message>
1916

20-
To publish your app:
17+
To publish your platform app:
2118

2219
1. Open the **Dev Console**.
23-
2. Select the application you want to publish.
24-
3. Go to the **Integrations** tab and submit your app.
25-
26-
This action gives you access to the marketing section of the
27-
application, where you need to add the following app information:
28-
29-
- **General App Info** - choose correct categories and platforms for your application to make it easier to find in the Integrations,
30-
- **App Description** - make sure it contains all information about your application that the customers may find useful,
31-
- **Short Description** appears next to your app logo, together with your app name;
32-
- **Long Description** is what the users see after they select your app to view its details. You can add clickable links to the long description.
33-
34-
<Message type='notice'>
35-
36-
Specific guidelines for screenshots and logos are provided in the Dev
37-
Console.
38-
39-
</Message>
40-
41-
When you're finished with providing the details about your app,
42-
submit your app for approval. Box will review your application
43-
and publish it in the Integrations.
44-
45-
In case of any questions or issues, contact the Partners team:
46-
[`integrate@box.com`][email]
20+
2. Select the platform app you want to publish.
21+
3. Go to the **Publishing** tab.
22+
4. Read through the submission checklist and check the confirmation checkbox if your app meets all the requirements.
23+
5. The next step is the marketing section of the app, where you need to add the following app information:
24+
25+
- **General Info** - choose correct categories and platforms for your app to make it easier to find in the Integrations,
26+
- **Description** - make sure it contains all information about your app that the customers may find useful,
27+
- **Short Description** appears next to your app logo, together with your app name;
28+
- **Long Description** is what the users see after they select your app to view its details. You can add clickable links to the long description.
29+
- **Screenshots** and **Icon** - provide the screenshots to allow the users see how the app looks like and how it integrates with Box. The icon is needed to represent your app in the list of Integrations.
30+
- **Support Resources** - A list of links and supplementary information that will help the users to work with your app.
31+
32+
6. Before submitting your app, preview it to see if you included all the necessary information.
33+
7. Submit your app for approval. Box will review your app and publish it under **Integrations**.
34+
35+
If you have any questions or issues, contact the **Partners** team:
36+
[`integrate@box.com`][email].
4737

4838
[integrations]: https://cloud.app.box.com/integrations
4939
[email]: mailto:integrate@box.com

content/pages/ai-dev-zone/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,22 +123,22 @@ view sample code, explore Box AI use cases, and more!
123123
Check out the high-level features of the Box AI API in one minute.
124124

125125
</Tile>
126-
<Tile image="API-text-gen" title="Endpoint overivew"
126+
<Tile image="API-text-gen" title="Endpoint overview"
127127
href="https://www.youtube.com/watch?v=xxR8aF4r3g8&list=PLCSEWOlbcUyI2ta24oRr75_4igvMzKJ9q">
128128
See a demo of the Box AI API text generation endpoint.
129129

130130
</Tile>
131-
<Tile image="API-q&a" title="Endpoint overivew"
131+
<Tile image="API-q&a" title="Endpoint overview"
132132
href="https://www.youtube.com/watch?v=UyKfacz6G9g&list=PLCSEWOlbcUyI2ta24oRr75_4igvMzKJ9q">
133133
See a demo of the Box AI API document Q&A endpoint.
134134

135135
</Tile>
136-
<Tile image="API-extract" title="Endpoint overivew"
136+
<Tile image="API-extract" title="Endpoint overview"
137137
href="https://www.youtube.com/watch?v=fijj0CX67c4&list=PLCSEWOlbcUyI2ta24oRr75_4igvMzKJ9q">
138138
Extract metadata with various prompt formats with Box AI API.
139139

140140
</Tile>
141-
<Tile image="API-extract-structured" title="Endpoint overivew"
141+
<Tile image="API-extract-structured" title="Endpoint overview"
142142
href="https://www.youtube.com/watch?v=dU3oo4sHZt0&list=PLCSEWOlbcUyI2ta24oRr75_4igvMzKJ9q">
143143
Extract metadata with predefined structure with Box AI API.
144144

0 commit comments

Comments
 (0)