How to configure Launchpad Application Service API
The Roambi server provides an Application Service API, which allows third party applications to launch a specific Roambi report via an exposed URL. The Application Service API allows you to launch Roambi visualizations from your own third party applications. Although Roambi and the third party application interact as separate applications on the iOS framework, mobile device users experience a seamless transition between the third party application and the Roambi report. Additionally, the Application Service API allows for a callback to the third party application when the application exits the Roambi report, which returns the user to the application.
Before you can use the Application Service API, you will need to obtain the report URL for the Roambi report that you want to launch from your 3rd party application. You can obtain the report URL from Roambi Business Publisher.
Select the i icon to the bottom right of the published Roambi analytic you wish to link to.
...and copy the APPLICATION url.
You can use the Application Service API to return end users to your 3rd party application when they exit the Roambi report. Use a callback parameter to automatically return to your 3rd party application.
To use a callback parameter to automatically return end users to your 3rd party application:
1. Encode the URL to your application. This encoded URL will become your callback parameter.
2. Append the callback URL to your UIApplication openURL as shown in the following example:
[[UIApplication sharedApplication] openURL:[NSURL URLWithString:@”roambi://business.roambi.com/?protocol=https&account=eb973209-d8eb-4939-bc65-651b6425e2a7&document=0049d706-ef69-4c06-92a2-521dea044303&portal=rfs&type=document?callback=mycallbackURL%3A%2F%2F”]];
Note that some Roambi views support parameter passing to deliver the user to a specific part of an analytic - see the articles here for:
- Launchpad for Roambi Squares
- Launchpad for Roambi Card
- Launchpad for Roambi Pulse
- Launchpad for Roambi Cardex
Note that this capability is only available for the iOS app.
KBA , BI-ROM-CLD-SRC , Roambi Cloud Service , How To