Apps

The Apps section of the CMS is where you can add and manage your apps which access the Storyteller API and is accessible to CMS users with the 'Developer' role.

Creating Apps

To Create a New Storyteller App, Complete the Following Steps in the CMS

• Select the ‘Apps’ option from the menu on the left-hand side of the CMS

• Click 'Add App' in the top right hand corner of the Apps section

• Enter the app’s Title in the text field provided

• Select the app’s Platform from the drop down list

• Fill out the fields according to the instructions below

App Configuration

Your app needs to be correctly configured for sharing in order to successfully direct users to your Stories.

For the Web SDK, when the user shares a link to a Story and another user clicks on it, the second user is directed to a web browser on their device which will open at the shared Story.

For the iOS and Android SDKs, the first user shares the link to the Story and after clicking the link the second user:

• is directed into the app and to the Story if they already have the app installed

• is directed to the App Store or Play Store on their device to install the app if they do not already have the app installed

Web

To correctly configure sharing for the Storyteller Web SDK, the following information must be added to your Web App:

• Domains

  • Domain 1: The domain on which you are using the Storyteller Web SDK e.g. yourdomain.com

  • Is Sharing Domain: this should be checked for the domain on which you are using the Storyteller Web SDK. When opening links shared from the Storyteller, users will be directed to this domain at the following URL: https://yourdomain.com/#stories/{storyId}

When finished, click 'Save' and an API Key will be created for that app which you can copy from the index view or in the App Editor.

iOS

To correctly configure sharing for the Storyteller iOS SDK, the following information must be added to your Storyteller iOS App:

• App Store Identifier

  • The ID of your app in the Apple App Store. If users access links shared from Storyteller and they do not have your app installed, we use this ID to send users to your app in the App Store.

  • This ID can be found in your App's URL on https://apps.apple.com. For example, the URL for the Twitter app is https://apps.apple.com/us/app/twitter/id333903271 and the App Store Identifier is 333903271. Note: only the numerical ID should be entered, id should be omitted. This ID can also be found by copying the sharing link for your app from the App Store.

• App ID:

  • To correctly enable sharing across all platforms, we automatically generate an apple-app-site-association file which contains this App ID and the App IDs of your other Storyteller iOS apps.

  • This App ID has the form <Application Identifier Prefix>.<Bundle Identifier> e.g. ABCDE12345.com.example.app.

  • Once your App ID has been added and the App has been saved, you can view the apple-app-site-association file for your tenant at the following URLs: https://yourtenantname.ope.nstori.es/apple-app-site-association and https://yourtenantname.ope.nstori.es/.well-known/apple-app-site-association.

When finished, click 'Save' and an API Key will be created for that app which you can copy from the index view or in the App Editor.

Note: the file may take up to 5 minutes to appear after saving your App.

An example apple-app-site-association file generated by Storyteller can be seen below:

[ { "relation": [ "delegate_permission/common.handle_all_urls" ], "target": { "namespace": "android_app", "package_name": "com.example.myapp", "sha256_cert_fingerprints": [ "12:3D:E4:56:C7:90:01:23:D4:EE:B5:67:8F:90:FC:12:34:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5" ] } } ]

Android

To correctly configure sharing for the Storyteller Android SDK, the following information must be added to your Storyteller Android App:

• App Store Identifier

  • The ID of your app in the Google Play Store. If users access links shared from Storyteller and they do not have your app installed, we use this ID to send users to your app in the Play Store.

  • This ID can be found in your App's URL on https://play.google.com/store/apps. For example, the URL for the Twitter app is https://play.google.com/store/apps/details?id=com.twitter.android and the App Store Identifier is com.twitter.android.

• To fully support deep linking across all Android versions, an assetlinks.json file is automatically generated for your tenant. More information about the assetlinks.json file can be found here. For Storyteller to generate this Digital Asset Links file, the "Package Name" and "SHA 256 Cert Fingerprint" fields should be completed.

  • Package Name

    • This is the application ID declared in the app's build.gradle file. This value should be the same as the "App Store Identifier" entered above. E.g. com.example.myapp.

  • SHA 256 Cert Fingerprint

    • This is the SHA256 fingerprint of your app's signing certificate. You can use the following command to generate the fingerprint via the Java keytool: keytool -list -v -keystore my-release-key.keystore. Or, if using the Google Play Store Signing, the SHA256 signature can be downloaded using the Google Play Console.

      1. Login to the Play Console

      2. Select the app you want to configure

      3. Go to Setup → App integrity

      4. Copy the SHA-256 value under "App signing certificate"

      5. This value should be entered into your Storyteller App's form without the "SHA-256: " prefix. E.g. 15:8D:E9:83:C5:73...

• Amazon Standard Identification Number (ASIN)

  • If your Android app is listed on the Amazon App Store, please enter the Amazon Standard Identification Number (ASIN) so that we can show user's a link to download your app if necessary.

  • This ID can be found on your App's URL on the Amazon Store. For example, the URL for the Twitter app is https://www.amazon.co.uk/dp/B004SOR4H6 and the ASIN is B004SOR4H6.

When finished, click "Save" and an API Key will be created for that app which you can copy from the index view or in the App Editor.

After saving your app, the Digital Asset Links file for your tenant can be viewed at the following URLs: https://yourtenantname.ope.nstori.es/assetlinks.json and https://yourtenantname.ope.nstori.es/.well-known/assetlinks.json

Note: the file may take up to 5 minutes to appear after saving your App.

An example Digital Asset Links file generated by Storyteller can be seen below:

[ { "relation": [ "delegate_permission/common.handle_all_urls" ], "target": { "namespace": "android_app", "package_name": "com.example.myapp", "sha256_cert_fingerprints": [ "12:3D:E4:56:C7:90:01:23:D4:EE:B5:67:8F:90:FC:12:34:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5" ] } } ]

Managing Apps

In the Apps section, you can also view and make changes to all of the apps added.

App Index

All of your apps are listed in the index view. The index view displays the following information for each app:

• Title

• Platform

• API Key

• Last Modified * date/time

Apps in the index view can be sorted by any of these four fields.

You can page through the index to view each of the apps or use the search bar at the top of the index to find a particular app by Title, quickly and easily.

Editing an App

To edit an app, click the ‘Edit’ button in the row of the app you want to make changes to.

After clicking Edit you will be able to change the properties of your app.

Click ‘Save’ once you’re finished with your changes.

Deleting an App

To delete an app, click the delete button in the row of the app you want to delete.

After clicking the delete button, you will be given the opportunity to abort the deletion by clicking ‘Cancel’ or confirm it by clicking ‘Yes, Delete.’

If you choose to delete an app, its API Key will become invalid and all calls from that app will then fail.