SAP Knowledge Base Article - Public

2326109 - How do I create a Roambi API client?

Symptom

How do I create a Roambi API client?

Environment

  • SAP Roambi Cloud

Resolution

Roambi provides a RESTful API for programmatic access to data in your Roambi account. This API uses the JSON format for data and OAuth for Authorization and Authentication. All aspects of Roambi API are modeled as structured objects. These objects and structures were designed to be intuitive and simple to use. For example, a "folder" object represents a storage destination, a "user" object has associated "roles" and "access level".

As a Roambi account administrator, you can create and configure Roambi API clients for use with the Roambi API. To create a new Roambi API client, follow these steps:

  1. Login as an administrator to your Roambi account
  2. Navigate to the administration console by accessing the "Administration" button from the gear icon in the upper right corner of the Roambi home screen
  3. Navigate to the "API Clients" section in the administration console
  4. Tap the "Create New API Client" button
    screen.png
  5. Input the Name, Description and Redirect URI for your API client
  6. Check the box to indicate that you have read and agreed to the Roambi API Terms of Use
  7. Tap the "Done" button in the upper right
    screen-2.png

Additional Notes:

  • The Redirect URI specified must match the redirect_uri parameter in the API call to the /authorize endpoint in order for Roambi to issue an Authorization Code.
  • Once your API client is created, you can view the details of your API client and get information used in your programmatic API calls by tapping the API client to expose it's details. 

**Please click here to download the documentation for more information**

Keywords

mobile roambi roam bi cloud , KBA , BI-ROM-CLD-SRC , Roambi Cloud Service , How To

Product

SAP Roambi Cloud all versions