Developer Hub
The Contentstack Developer Hub is an app development framework/portal that developers can leverage to rapidly build, host, and publish ready-to-use private or public apps.
The Contentstack App Framework consists of app development APIs, SDKs, and other tools that help you build apps with ease. Using this framework, you can create private apps (only for your organization) and public apps (listed in the Public marketplace for any of the CS customers to use, for example, third-party integrations, Contentstack apps, and so on).
Get acquainted with the two types of Apps Contentstack supports.
- Stack Apps : These apps can be installed for any specific stack, and the scope is limited only to that stack. This type of app can be installed by only the owners/admins of the stack or by the owners/admins of the corresponding org. The org owners/admins need to be part of the stack.
- Organization Apps: These apps have a broader scope, and the changes are applicable throughout the organization. A good example is the SCIM app that allows automatic user provisioning for all new users of the organization. This type of app can be installed only by the owners/admins of the corresponding org.
Introduction
Learn how to create, install, and manage Apps in the Developer Hub.
Creating an App
To create a new app:
- On the left navigation panel, click the Developer Hub icon.
- Click the + New App button.
- In the New App modal that appears, enter the following details:
- Type of App (required): Select the type of app you want to create: Organization App or Stack App.
- Name (required): Enter a suitable name for your app (for example, Sample App).
- Description (optional): Enter a description for your app.
- Click the Create button.
- On the Basic Information screen, you can view the entered details about your app.
- On the left-hand side navigation panel, you will find OAuth, UI Locations, and Webhooks that lets you define further details for your app.
Installing an App
Once your app is ready, you can test the app by installing it in your preferred stack.
- Click the app card to go to the app’s Basic information page.
- Click the Install App button on the top-right side. Another quick step is to open the URL in a browser https://app.contentstack.com/!#/apps/{your_app_UID}/install.
- In the case of a stack app, you are prompted to select the stack within which you want to install the app. Select the stack and click Install.
- You will be redirected to the configuration page to fill in the required information related to the App to complete the installation. After adding the details, click the Save button.
- In the case of an organization app, you will be asked to allow access to specific modules of your Contentstack account. Click Authorize & Install to proceed.
- Once you install an app, you can find the app in Marketplace > Manage > Installed Apps. You can hover over the app and update the app configuration, and uninstall it.
- Media: https://www.canva.com/design/DAGRIHHKIqU/OFo9fnH8eFi6zWKtSalCGg/view
Configuring an App
When updating an app, you can either update the configuration details or uninstall the app. To configure an app, perform the following steps:
- Navigate to Contentstack Marketplace.
- Click Manage on the left-side navigation panel, and select Installed Apps.
- Click on your app, say Cloudinary. You will see a modal with details such as Overview (display the information on the app), Screenshots (few screenshots of the app), Use Cases (where you can use the app), and Installed On.
- By default, you will already be on the Installed On tab.
- Hover over the Cloudinary app. You will find two icons for “Configuration” and “Uninstall”.
- Click the Configuration icon. You will find the existing configuration details of your Cloudinary account, such as the Cloud Name and the API Key, to let your app fetch details from and to Cloudinary.
These details are configured when you create your app. Once done, click Save to save the new configuration details. You can also do the following:
- You can also do the following:
- Click the More Options icon (three ellipses) and select Uninstall from Stack to uninstall your app from the stack.
- Click the Cancel button to cancel the update.
- Click the Open Stack button to directly navigate to the stack.
Managing an App
You can manage all your installed/authorized apps and installation requests from the Manage section (tab next to Discover in the left navigation panel). To see the installed/authorized apps in your stack, follow the steps below:
- In the left navigation panel, click the Marketplace icon.
- On the screen that appears, click the Manage button.
- Under the Manage > Installed Apps section, you will find your installed apps. Here you can configure or uninstall your apps as needed.
- Under the Manage > Authorized Apps section, you will find your authorized apps.
Uninstalling an App
To uninstall an app, follow the steps below:
- Open Marketplace, and go to Manage > Installed Apps.
- Click the app that you want to uninstall.
Go to the Installed On tab. You will see the list of stacks in which the app is installed. Hover over the stack from which you want to uninstall the app. You can see the icons for Uninstall App and Configuration.
- Click the Uninstall icon to uninstall the app.
- Enter the name of your application in the pop-up box and click Uninstall to permanently remove the app and all its associated data.
- Media: https://www.canva.com/design/DAGRIBQ8EDY/ruP93pUHQ3r8x099sha6Sw/view
Deleting an App
To delete an app, perform the steps given below:
- Click the App you want to delete.
- In the Basic Information section of your app, click the Delete App button at the top.
- You will be prompted to enter the App name and click Delete.
Media: https://www.canva.com/design/DAGRIBu89mA/imOp9iJCS5vvvo6T0eeWWg/viewnbsp;
UI Locations
- An application is a container of one or more UI locations that allow you to extend the Contentstack platform to facilitate integrations, add new functionality, and customize the platform experience.
- You can use different locations within a single app to build an immersive experience that integrates third-party applications or introduces custom functionality and workflows for users.
- Once an app has been created, it can be distributed as a single application based on the application's use case.
Contentstack OAuth
- Contentstack OAuth uses the OAuth 2.0 protocol that allows external applications and services to access Contentstack APIs on behalf of a user. You can implement an OAuth connection to Contentstack by creating apps in the Developer Hub console.
- Contentstack OAuth allows the resource owner (user) to share the protected data from the Contentstack resource server (API) without sharing their credentials.
