Skip to content

Commit

Permalink
Merge branch 'main' into DDOC-1229-model-updates
Browse files Browse the repository at this point in the history
  • Loading branch information
wsocha authored Jan 10, 2025
2 parents 1f30498 + f09304d commit f88ecd7
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 70 deletions.
3 changes: 2 additions & 1 deletion .spelling
Original file line number Diff line number Diff line change
Expand Up @@ -334,4 +334,5 @@ Anthropic
GPT-4o-2024-05-13
text-embedding-ada-002
params
GPT-4o-mini
GPT-4o-mini
unpublish
2 changes: 0 additions & 2 deletions content/guides/api-calls/api-versioning-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ To stay informed about the forthcoming API modifications, monitor the [Changelog

</Message>

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

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

</Message>
-->

## How Box API versioning works

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 29 additions & 31 deletions content/guides/applications/integrations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,60 +14,58 @@ alias_paths:

# Integrations

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 Integrations can be a great way to find new users.
Integrations groups apps into sections so that you can
[Box Integrations][app-center] is the first place for Box users to find out
about applications they can use in combination with Box. If your
application can be used by other enterprises, listing your service in
under **Integrations** can be a great way to find new users.
Integrations group apps into sections so that you can
quickly find featured, most popular, or recently added apps.

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

## Developing and app or becoming a Box Partner
## Developing a platform app or becoming a Box Partner

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.
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.

## Publishing an app
## Publishing a platform app

Use the following steps to publish an application in Box Integrations.
Use the following steps to publish a platform app in Box Integrations.

### Prerequisites

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 Integrations does not support any other authentication methods.
* You are a developer with access to the application in the [Developer Console][devconsole].
* The platform app is in a finished state and ready for production usage.
* The platform app leverages OAuth 2.0 authentication, as Integrations do not support any other authentication methods.
* You are a developer with access to the platform app in the **Developer Console**.

### Steps

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

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

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

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

Once a request for approval is received, the Box Partner team will be
notified and review your request as soon as possible.
5. Use the **Preview** button in the top right corner to see how your application will look when listed.
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 [`[email protected]`][email].

For any questions, please email [`[email protected]`][email] or submit a
support ticket.
</Message>
## Unpublishing a platform app

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

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 **Integrations** panel from the left-hand
sidebar. The app can be unpublished from this page.
1. Navigate to the **Developer Console** and select your platform app.
2. Select the **Publishing** tab.
3. You can now unpublish the app.

[app-center]: https://app.box.com/services
[devconsole]: https://cloud.app.box.com/developers/console
[email]: mailto:[email protected]
[bp]: https://support.box.com/hc/en-us/sections/360009473734-Box-Partner-Resources
[bp]: https://support.box.com/hc/en-us/sections/21356597387539-Box-Partner-Programs
54 changes: 22 additions & 32 deletions content/guides/getting-started/publish-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,38 @@
rank: 3
---

# Publish your application
# Publish your app

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

<Message type='warning'>

Only applications that use the OAuth 2.0 authentication have a
built-in publication option. You can use other user authentication
types, but such app can only serve as a marketing listing in the
Integrations and redirect customers to your website.
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.

</Message>

To publish your app:
To publish your platform app:

1. Open the **Dev Console**.
2. Select the application you want to publish.
3. Go to the **Integrations** tab and submit your app.

This action gives you access to the marketing section of the
application, where you need to add the following app information:

- **General App Info** - choose correct categories and platforms for your application to make it easier to find in the Integrations,
- **App Description** - make sure it contains all information about your application that the customers may find useful,
- **Short Description** appears next to your app logo, together with your app name;
- **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.

<Message type='notice'>

Specific guidelines for screenshots and logos are provided in the Dev
Console.

</Message>

When you're finished with providing the details about your app,
submit your app for approval. Box will review your application
and publish it in the Integrations.

In case of any questions or issues, contact the Partners team:
[`[email protected]`][email]
2. Select the platform app you want to publish.
3. Go to the **Publishing** tab.
4. Read through the submission checklist and check the confirmation checkbox if your app meets all the requirements.
5. The next step is the marketing section of the app, where you need to add the following app information:

- **General Info** - choose correct categories and platforms for your app to make it easier to find in the Integrations,
- **Description** - make sure it contains all information about your app that the customers may find useful,
- **Short Description** appears next to your app logo, together with your app name;
- **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.
- **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.
- **Support Resources** - A list of links and supplementary information that will help the users to work with your app.

6. Before submitting your app, preview it to see if you included all the necessary information.
7. Submit your app for approval. Box will review your app and publish it under **Integrations**.

If you have any questions or issues, contact the **Partners** team:
[`[email protected]`][email].

[integrations]: https://cloud.app.box.com/integrations
[email]: mailto:[email protected]
8 changes: 4 additions & 4 deletions content/pages/ai-dev-zone/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,22 +123,22 @@ view sample code, explore Box AI use cases, and more!
Check out the high-level features of the Box AI API in one minute.

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

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

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

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

Expand Down

0 comments on commit f88ecd7

Please sign in to comment.