Deep Links (Action URLs)

Modified on Mon, 4 Jun, 2018 at 2:50 PM

In this technical documentation, you can find information about action URLs or links that could be used within the app or to content.

Internal links use the following scheme purple: //<ACTION URL>

External links use the following scheme purple-<PACKAGE_NAME>://

The <PACKAGE_NAME> can be found on the app overview page in the Purple DS Manager.

Sample:
The following link opens the menu entry "App Information".

Internal link purple://app/info/open
External link purple-com.sprylab.sprylab://app/info/open

The following list includes all frequently used action URLs.

A complete list including technical parameters can be found here.

Event	Action URL
Events in App Menu
Open app information	purple://app/info/open
Open app settings (Android only)	purple://app/settings/open
Open app menu	purple://app/menu/open
Close app menu	purple://app/menu/close
Toggle app menu	purple://app/menu/toggle
Open push registration (IOS only)	purple://app/push/register
Open bookmarks view	purple://app/bookmarks/open
Add bookmark	purple://content/bookmark/add
Open feedback mail (see Create Feedback E-Mail Address )	purple://app/feedback/mail/open
Show dynamic html content (see Individual App menu )	purple://app/resource/dynamic/<PATH> Further parameters for this action URL are possible, see Proprietary HTML Content
Share app or issue	purple://app/share_app_or_issue
Open home ( opens the start point of the app as defined in basic settings )	purple://app/home/open
Register Push Service	purple://app/push/register
Open external URL	purple://app/open/external/url/<`URLEncodedURL>` `NOTE: The target URL must first be URL encoded, e.g. at https://www.url-encode-decode.com/ On iOS the system (default) browser will open, e.g. Safari. On Android, an instance of the system browser (e.g. Chrome) is opened within the app. This browser contains all browser features such as bookmarks, sharing, reading lists, history etc. and can open the content in an external window of the browser via the extended menu (3 dots).`
Events in Newsstand
Open kiosk (newsstand)	purple://kiosk/open
Open newsfeeds (first newsfeed)	purple://kiosk/feed/open
Open category chooser ( Publication menu )	purple://kiosk/category/chooser/open
Show issue preview ( Alias is set in issue settings in Purple DS Manager)	purple://kiosk/issue/alias/<ISSUE_ALIAS>/preview
Open Entitlement login page	purple://kiosk/entitlement/login/open
Perform entitlement login (if successful, it opens url_encoded_action_url)	purple://kiosk/entitlement/login/perform?login_name=<LOGIN_NAME>&token=<ACCESS_TOKEN>&roles=<ROLES>&success_url=<URL_ENCODED_ACTION_URL>
Perform entitlement logout (if successful, it opens url_encoded_action_url)	purple://kiosk/entitlement/logout/perform?success_url= <URL_ENCODED_ACTION_URL>
Open subscription administration view	purple://kiosk/subscriptions/open
Start In-App Purchase ( for Product ID see InApp Purchases)	purple://kiosk/products/<PRODUCT_ID>/purchase
Restore purchases (only iOS )	purple://kiosk/products/restore
Open issue	purple://kiosk/issue/alias/<ISSUE_ALIAS>/open or to a specific page: purple://kiosk/issue/alias/<ISSUE_ALIAS>/page/alias/<PAGE_ALIAS>/open
Open publication ( open a selected publication or newsfeed )	purple://kiosk/publication/`<PUBLICATION_ID>`/open
Events in Issue / Article
Open table of contents	purple://content/toc/open
Navigate inside an issue via alias	purple://content/page/alias/<ALIAS>/open
Navigate inside an issue via index	purple://content/page/index/<INDEX>/open
Add bookmark	purple://content/bookmark/add