10 min read
The App Directory is hosted by Integry as a public listing of all apps that your users can create integrations with, these integrations can be made on Integry or on any other platform. Shown below is an example of a basic App Directory with Integry’s subdomain and branding, this is how your App Directory cards will appear to your users.
Click on Create a Deployment. You will then be asked to select a deployment type as shown below.
There are two types of deployments. First is the embedded SDK deployment, which is basically the deployment of integrations on an SDK that will be embedded inside your app. The second is the Directory deployment that publishes your integrations in an App Directory on a subdomain that you provide. Select this second option to create an App Directory.
1. Basic Information
After selecting the Directory deployment, you will land on its configuration page which starts off with the Basic Info section of your Directory, as shown below.
You can pick between setting up a custom domain or add the Directory URL first. Add the link to your homepage and your Login URL for SSO which will be used to redirect the user for Single Sign-On. Login URL information is required to redirect an end-user to the relevant link when they click on Sign in. You can add your Google Analytics Tracking ID if you’re using one.
On the right, you can preview how this information will appear on the actual page, you also have the option to open the preview in a new tab. Upon clicking the Next button at the bottom right, your changes will be automatically saved.
2. Directory Appearance
After providing the basic information and upon clicking Next, you will be taken to the Directory Appearance section as shown below.
In this section, you can add a title, header text, favicon, logo, header image, background, and text colors for your card. You can also enable or disable automatic categories and select whether you want to show 2, 3, or 4 cards per row.
You can also select a category panel position between left, top, or right. Add your action title and description on the Directory and provide a URL for the action button which will direct the user to a specific link when you click on the action button.
You can also add your social media accounts such as Facebook, Twitter, and LinkedIn. On the right, you can preview how this information will appear on the actual page, you also have the option to open the preview in a new tab. Upon clicking the Next button at the bottom right, your changes will be automatically saved.
3. Card Page Appearance
After adding the details of your Directory’s appearance and upon clicking Next, you will land on the Card Page Appearance section as shown below.
Here you can enable or disable keywords, card logo, and screenshots for your Card Page. You can also select the links panel position as well as the background and text colors for your card.
On the right, you can preview how this information will appear on the actual page, you also have the option to open the preview in a new tab. Upon clicking the Next button at the bottom right, your changes will be automatically saved. The Next button only appears the first time you’re adding this information, upon editing there’s no Next button and the changes are automatically saved.
4. Cards and Categories
After adding the details of your Card Page Appearance and upon clicking Next, you will land on the Cards and Categories section as shown below.
Here you can do three main things: add an existing card, add a new card, and add new card categories. When you land on this section, you will see two buttons: Add Card and Add Category, details of what happens when you click on either of these buttons are provided below.
Adding an existing card
When you land on the Cards section, you have the option to Add Card, hovering over the Add Card button will give you a preview (on the right) of how cards will appear in the Directory. Clicking Add Card will show you a Select Card field in the dropdown, as shown below.
You can search or scroll to select an existing card from the dropdown and add it to your Directory. Once you have selected a card, it will be added to a category it is already categorized under, the category title is changeable and a card can be added to multiple categories. If the card is not categorized under any category, an Uncategorized category will be created for it.
Adding a missing card
If you can’t find a card in the dropdown list, you can create a new card. This can be done by clicking on the Add Card button and selecting Create New Card on the Select Card dropdown. Upon selecting this option, a new card will be created and added to an Uncategorized category, while the Card Settings section will be loaded on the right side of the same page, as shown below.
In the Card Settings section you can add your card’s title and summary which will appear below the title. Add the card icon which will appear on your card; it must be square, 128px ⨉ 128px, and 2 MB in size. Select a color for your card.
The Action URL that you add for your card, will define where the user will go when they click on the card. You can define single or multiple categories for your card under the Categories section. You can add multiple tags for your cards under the Keywords section.
You can enable or disable your card’s product page through a toggle button. Enabling the product page will lead you to the card’s product page upon clicking the card in your directory while disabling it will lead you to the card’s action URL when you click the card.
Add at least 3 screenshots of your card in the Screenshots section. If it’s an app or integration you will be asked to add images that will clearly display your card’s interface and functionalities. Your screens should not be smaller than 1200px x 750px.
Add a description for your card, it will appear as the main text of your card’s page. Once you’ve added the details, your changes will be automatically saved and the new card will be added to all the categories you’ve selected for it.
When you hover over a card, you will see an icon on the left for dragging and on the right, you will see a cross icon and an arrow. Upon clicking the arrow, you can edit your Card Settings which appear on the right side of the same page. By clicking the cross icon, you will be able to remove the card from its current category.
Adding a category
When you land on the Cards section, there are two options available to you, one is to Add Card as previously mentioned and the other is to Add Category. Upon clicking the Add Category button, a new category will appear on the page with the title Category Heading where you can add the category heading simply by clicking on it and typing.
When you hover over any category, you will see an icon on the left for dragging while on the right you will see an edit icon, a plus icon, and an arrow. Upon clicking the arrow, the Category Settings will appear on the right side of the same page as shown below.
Here you can add a title, enable or disable show, select a sorting option, add the number of rows to be shown for the category, and a button at the bottom to Delete Category (if you delete a category, it will remove the category and all the apps categorized under it).
Upon clicking the edit icon, you can rename the category. Upon clicking the plus icon you can add another card to the category.
All cards and categories in the Cards section can be dragged, dropped, and renamed. If you’re dragging a category, the category will collapse all the cards and only show the category heading.
The default interface of your App Directory will be in English. However, you have the ability to add multiple languages to this interface. The Localization section in your Directory can be seen below.
You can click on the Add Language button to add more languages on top of the English language. You can provide the page title and description in each respective language. You can also select the default language of your Directory through the selection button on the far right.
After finishing with the localization settings, click the Add Languages button on the bottom right to save these settings.
After you finalize and save your App Directory, it will appear in your deployments menu as shown below.
After this, all you need to do is provide the URL of your App Directory to your users. You can do that by adding it to the Integrations section inside your app. Once your users click on this URL, they will land on your App Directory homepage.
App Directory requires integration with your authentication so that the users can create integrations. Without this, users will only be able to view, and not create integrations.