diff --git a/content/pages/platform/box-platform-101.md b/content/pages/platform/box-platform-101.md index 544cbb296..1481db0d6 100644 --- a/content/pages/platform/box-platform-101.md +++ b/content/pages/platform/box-platform-101.md @@ -9,50 +9,49 @@ rank: 1 ## What is Box -[Box][box] is a cloud-based content management -and file sharing platform that enables -individuals and businesses to store, access, and collaborate on documents and -files from anywhere. It offers features like secure file storage, real-time -collaboration, and integrations with various productivity tools, enhancing team -efficiency and data accessibility. Known for its focus on security and -user-friendly interface, Box is widely used for managing digital assets and -fostering collaboration within organizations. +[Box][box] is a cloud-based content management and file sharing platform that +enables individuals and businesses to store, access, and collaborate on +content from anywhere. Known for its focus on security and user-friendly +interface, Box is widely used for managing digital assets and fostering +collaboration within organizations. +Box [integrates with various productivity tools][integrations], enhancing team +efficiency and data accessibility. ## What is Box Platform -[Box Platform][platform] is a set of tools and APIs offered by Box that -allows developers to integrate and -customize the capabilities of the Box cloud content -management system into their own applications and services. It enables -businesses and developers to build -secure and scalable content-centric applications, -leveraging features like file storage, sharing, and collaboration while -maintaining control over data and access. With Box Platform, developers can -create tailored solutions that enhance productivity and streamline content -management workflows. +[Box Platform][platform] is a set of tools and APIs offered by Box. It +allows developers to integrate and customize the capabilities of the Box cloud +content management system into their own applications and services. +With Box Platform, businesses and developers can build secure and scalable +content-centric applications. Leverage features like file storage, +sharing, and collaboration while maintaining control over data and access. +You can create tailored solutions that enhance productivity and streamline +content management workflows. ## How do I make applications -In order to use the [Box API][api], you first have to create an application in -Box. This application serves as the gateway for any API call made to the -platform. You can use two websites to accomplish this task: the Box Developer -Site and the Box Developer Console. Let's take a closer look at what those are. +In order to use the [Box API][api], you first have to +[create an application][app] in Box. This application serves as the gateway for +any API call made to the platform. +Create your app in the Developer Console while using the resources available on +the Box developer site. Let's take a closer look at what those two websites are. -### Box Developer Site +### Box developer site -The Box Developer Site is this website you are reading right now. It is a +The Box developer site is the website you're browsing right now. It is a comprehensive resource for developers building solutions on top of Box, and should be used alongside the developer console to create applications and make -API calls. You can -find a multitude of guides, the full OpenAPI spec, quick starts, sample code, -etc all within its pages. +API calls. You can browse the [guides][guides], full OpenAPI specs, quick +starts, [sample code][samples], all within its pages. Check the +[getting started][getting-started] page to learn about sections of our +documentation. ![Box Developer Site](images/developer_site.png) -The site is updated on a frequent basis with the -latest updates posted to the [changelog][change]. +The site is frequently updated, and the latest updates are posted +to the [changelog][change]. ![Box Developer Changelog](images/changelog.png) @@ -62,17 +61,16 @@ latest updates posted to the [changelog][change]. The [Box Developer Console][dc] is an interactive interface that provides developers with tools and resources for managing their applications integrated -with Box. It allows for the creation, configuration, and monitoring of apps, -offering insights and control over how these apps interact with the Box +with Box. Using the console, you can create, configure, and monitor apps, +gaining insights and control over how these apps interact with the Box platform. ![Box Developer Console](images/developer_console.png) -After you create an application in the console for the first time, -you will start seeing a button in the bottom left of the main Box web app. You -can use this button to access the console in the future. +After you create your first application in the console, a **Dev Console** +button appears in the main Box web app. Use this button to access the console in the future. ![Box Developer Console button](images/developer_console_button.png) @@ -80,25 +78,31 @@ can use this button to access the console in the future. ## Box Platform Concepts -In the following learn sections, we will go into more depth on various topics. -But at a high level, these are some terms and concepts to be familiar with. +Here are some terms and concepts you'll need to be familiar with before we +go into more depth on specific topics. ### User Types There are several [user types][ut] to keep in mind when developing on Box -Platform. These include users with admin privileges (such as Admin or Co-Admin -users) and those without admin privileges (Managed or External Users). -Additionally, there are platform-only users, which are categorized as Service -Accounts and App Users. Each user type has specific roles and access levels -within the Box environment, impacting how they interact with applications and -content. At the core, if a user can access a piece of content from the main Box -web app, they should be able to access it using the API. +Platform. These include users with admin privileges (such as [Admin or Co-Admin +users][admin]) and those without admin privileges ([Managed][managed] or +[External Users][ext]). +Additionally, there are platform-only users, which are categorized as +[Service Accounts][SA] and [App Users][appuser]. Each user type has specific +roles and access levels within the Box environment. It impacts how they +interact with applications and content. At the core, if a user can access a +piece of content from the main Box web app, they should be able to access it +using the API. ### Application Type There are three main types of applications that can be created in the developer -console. They include Platform App, Limited Access App, and Box Custom Skills. You -can also create third party and web app integrations. +console: +- custom app, +- limited access app, +- custom skills. + +You can also create third party and web app integrations. ![Application Types](images/app_type.png) @@ -106,8 +110,8 @@ can also create third party and web app integrations. ### Authentication Method -Depending on the application type selected, there are one of five different -authentication methods that can be used to gain an [access token][at]. An +There are five different authentication methods you can use to gain an +[access token][at], depending on the application type you selected. An access token is the key to get through the gateway that is your application to successfully make an API call to Box. @@ -119,14 +123,24 @@ to successfully make an API call to Box. Next step +[admin]: page://platform/user-types/#admin-or-co-admin-user +[managed]: page://platform/user-types/#managed-users +[ext]: page://platform/user-types/#external-users +[SA]: page://platform/user-types/#service-account +[appuser]: page://platform/user-types/#app-user +[integrations]: https://www.box.com/integrations +[app]:g://getting-started/first-application [box]: https://www.box.com [platform]: https://www.box.com/platform [apptypes]: g://applications/app-types/select [authmethods]: g://authentication/select -[api]: page://reference +[api]: https://developer.box.com/reference/ [change]: page://changelog [dc]: https://app.box.com/developers/console [at]: g://authentication/tokens +[guides]: https://developer.box.com/guides/ +[samples]: https://developer.box.com/sample-code/ +[getting-started]: g://getting-started [ut]: https://support.box.com/hc/en-us/articles/4636533822483-Box-User-Types diff --git a/content/pages/platform/index.md b/content/pages/platform/index.md index 5e135be89..02dadaa56 100644 --- a/content/pages/platform/index.md +++ b/content/pages/platform/index.md @@ -5,9 +5,9 @@ rank: 0 # Learn Box Platform -If you are new to Box, **start here**! -In the following pages, you'll learn how all the Box Platform -concepts and components work together to help you create an application quickly. +**Start here** if you are new to Box! +In the following pages, you'll learn the basics of [Box Platform][platform] to +help you create an application quickly. @@ -18,27 +18,32 @@ on everything Box Platform. --> + + ## Learn Sections -These pages go into more depth on each topic. Checkout each one and become -a Box Platform expert. +These sections explain how the concepts and components of Box Platform work +together. Use Box glossary[glossary] to learn the terms and definitions we use in Box +Platform. -- [Box Platform 101][platform101] -- [Use Cases][usecases] -- [User Types][usertypes] -- [Application Types][apptypes] -- [Authentication Methods][authtypes] -- [Support][support] -- [Tools][tools] +- Box Platform 101[platform101] +- Use Cases[usecases] +- User Types[usertypes] +- Application Types[apptypes] +- Authentication Methods[authmethods] +- Support[support] +- Tools[tools] - Get Started + Get Started -[platform101]: page://platform/box-platform-101 -[usecases]: page://platform/use-cases -[usertypes]: page://platform/user-types -[apptypes]: page://platform/application-types -[authtypes]: page://platform/authentication-methods -[support]: page://platform/support -[tools]: page://platform/tools \ No newline at end of file +[box-glossary]:page://platform/box-glossary +[platform101]:page://platform/box-platform-101 +[usecases]:page://platform/use-cases +[usertypes]:page://platform/user-types +[apptypes]:page://platform/application-types +[authmetods]:page://platform/authentication-methods +[support]:page://platform/support +[tools]:page://platform/tools +[platform]: https://www.box.com/platform diff --git a/content/pages/platform/use-cases.md b/content/pages/platform/use-cases.md index ff66526fc..7b996fe59 100644 --- a/content/pages/platform/use-cases.md +++ b/content/pages/platform/use-cases.md @@ -7,29 +7,29 @@ alias_paths: # Use Cases -Before beginning application development, it is best to assess if your use +Before you begin application development, it is best to assess if your use case is a good fit for the Box Platform. Generally speaking, content centric processes perform best. -Some questions to ask when assessing if a use case include: +Here are some questions to ask when you're assessing your use case: - Is content always involved in the process? - Does the process involve moving content from one place to another? - Can the workflow abide by [waterfall permissions][waterfall]? -- Does the process involve administrative tasks that may be automated? +- Does the process involve administrative tasks that can be automated? If you answered **yes** to the above questions, you most likely have a great use case for Box Platform. Some common customer solutions include: -- Marketing asset management -- Secure document vaults -- Wealth management portals -- Automatic folder creation based on user provisioning -- Adding relevant metadata using machine learning -- Claim reviews with built-in approval/rejection flows -- Event monitoring for security and auditing +- Marketing asset management. +- Secure document vaults. +- Wealth management portals. +- Automatic folder creation based on user provisioning. +- Adding relevant metadata using machine learning. +- Claim reviews with built-in approval/rejection flows. +- Event monitoring for security and auditing. Still not sure if you have a good use case? Reach out to your Box account team. diff --git a/content/pages/platform/user-types.md b/content/pages/platform/user-types.md index 87f98fc09..3677e0682 100644 --- a/content/pages/platform/user-types.md +++ b/content/pages/platform/user-types.md @@ -25,14 +25,18 @@ alias_paths: # User Types A critical part of planning and developing an application is understanding the -types of users involved. There are four main types of users: managed (internal -and external), admin, service account, and app users. Let's take a closer look -at the differences. +types of users involved. There are four main types of users in Box: +- managed (internal and external), +- admin, +- service account, +- app users. + +Let's take a closer look at the differences. # What type of user does my application use? -The type of user an application is authenticated as is dependent on the +The type of user an application is authenticated as depends on the type of application created, as well as the type of authentication used to create an Access Token. @@ -42,16 +46,14 @@ create an Access Token. The Box Admin is the principal Box account administrator. They can make additional co-admins with similar or more restrictive administrative -privileges. Admins and Co-Admins -can directly edit, delete, enforce security settings, and run reports against -these users via the Admin Console. +privileges. Admins and Co-Admins can directly edit, delete, enforce +security settings, and run reports against users in the Admin Console. ## Managed Users -Each Box enterprise is assigned a unique enterprise ID. Managed Users are any -users that belong to one enterprise ID. Managed Users consume a standard Box -license and often, but not -always, share the same email domain. +Each Box enterprise is assigned a unique enterprise ID. [Managed Users][mu] are +any users that belong to one enterprise ID. Managed Users consume a standard +Box license and often, but not always, share the same email domain. # Log in as Admin User @@ -61,13 +63,13 @@ properly operate and therefore require an Admin to log in. An example of this would be a security application that monitors enterprise events and takes action on suspicious events. The events endpoint can only -be used by Admins or a Co-Admin with permission to access reporting. +be used by Admins or Co-Admins with permissions to access reporting. ## External Users -An externally managed user, or External User, is a Managed +An externally managed user, or [External User][eu], is a Managed User that belongs to a different enterprise ID. External users are often encountered when they are collaborated in on content owned by a Managed User of the application's enterprise, or when they authorize an OAuth 2.0 application. @@ -301,7 +303,10 @@ would need to turn on this switch. [getuser]: e://get-users-me [updateuser]: e://put-users-id [createuser]: e://post-users -[events]: e://get-events +[events]: e://get-events/ +[mu]: https://support.box.com/hc/en-us/articles/32209778850067-About-Managed-Users +[eu]: https://support.box.com/hc/en-us/articles/32132489860115-About-External-Users +[uu]: https://support.box.com/hc/en-us/articles/32138574148499-About-Unmanaged-Users [cm]: https://support.box.com/hc/en-us/articles/360044197333-Using-the-Content-Manager [uag-tab]: https://support.box.com/hc/en-us/articles/360043695714-Admin-Console-Guide