Apty Bundles

You can download and host Apty Bundles, which appears to be in JavaScript or JSON format, to fetch and display your content from your own server rather than from Apty's cloud(AWS). If you wish to employ a self-hosted deployment model, you can use this approach and take complete control of the content deployment and security processes without the need to rely on a service outside your control.

Note:

The Apty Bundles section will be visible in the Admin Portal only if the Self Hosted feature is enabled. Please connect with your Apty Assistant if you want to enable this feature.

You can download the following three Apty Bundles:

Content Bundle - Content Bundle is a bundle of Apty content in JSON format which when hosted in your private network/server, enables you to fetch the content directly from your private network/server and display it in your Apty Client.
Injected Player Bundle - Injected Player Bundle consists of data in JavaScript format that enables you to display the content through the injected Apty Client, on your application.
Fonts Bundle - Fonts Bundle consists of all the required font files for you to customize your Apty Client.

Note:

As the name suggests, the Injected Player Bundle only works for Apty Client/Player installed using the Injected mode. You don't need to download the Injected Player Bundle if you are using the Apty Client/Player Extension.

You can use Apty Bundles in one of the following ways:

Manual Integration

To manually integrate Apty Bundles for self-hosted models:

1. Log in to the Admin Portal.

2. Click System Settings in the left panel.

system settings nav

3. Click Downloads.

Note:

Ensure that the Self Hosted feature flag is enabled to view the Apty Bundles in the Download section.
Apty recommends you to select the latest version from the dropdown to experience a seamless content creation process.

4. In the Apty Content section, download the required Apty Bundles.

Note:

Once you click the Content Bundle download button, you can select your application who's content you want to access.
If you are using the Apty Client/Player Extension, you don't need to download the Injected Player Bundle. Your content will still be displayed through the Apty Client Extension.

5. Unzip the downloaded Apty Bundles and host them in your private network/server.

6. Navigate to the Self Hosted section in the Admin Portal and insert the required URL paths.

URL

Content URL Path

JavaScript URL Path

This field can remain empty incase you're using the Apty Client Extension.

Fonts URL Path

7. Click Save.

8. Once the URLs are updated, push the changes to your end users depending on the type of Apty Client used.

Note:

It's mandatory to Rebuild & Push your Apty Client Extension to be in sync with your updated Apty Bundles.

Apty Client (Extension)
1. Navigate to the Client Version section and then click the Rebuild and Push button.
2. To learn more, see Rebuild, Auto Rebuild, and Custom Build Client Version.
3. From the Downloads section, download the Apty Client Extension with the latest updates.
Apty Client (Injected)
1. Navigate to the Injected Hook section in System Settings.
2. Update the URLs in the code snippet.
3. Click Save.

API Integration

To access the Apty Bundles functionality using APIs:

1. Execute the Open API provided by your Apty Assistant at your end. For example,

Content Bundle - https://{host}/assist/api/downloads/{tenantId}/content
JavaScript Bundle - https://{host}/assist/api/downloads/{tenantId}/client-injected
Fonts Bundle - https://{host}/assist/api/downloads/{tenantId}/fonts

2. Successful execution will hit the API that will automatically download all the required bundles and store them in your private network/server.

3. Navigate to the Self Hosted section in the Admin Portal and insert the required self-hosted URL paths.

URL

Content URL Path

JavaScript URL Path

This field can remain empty incase you're using the Apty Client Extension.

Fonts URL Path

4. Click Save.

5. Once the URLs are updated, push the changes to your end users depending on the type of Apty Client used.

Note:

It's mandatory to Rebuild & Push your Apty Client Extension to be in sync with your updated Apty Bundles.

Apty Client (Extension)

1. Navigate to the Client Version section and then click the Rebuild and Push button.
2. To learn more, see Rebuild, Auto Rebuild, and Custom Build Client Version.
3. From the Downloads section, download the Apty Client Extension to use the Apty Client with the latest updates.

Apty Client (Injected)
1. Navigate to the Injected Hook section in System Settings.
2. Update the URLs in the code snippet.
3. Click Save.