Roambi Business API FAQs

What is the Roambi API?

The Roambi API allows Roambi Business customers to have complete control in creating custom connectors to transport data from nearly any data source (e.g., cloud-based BI, on-premise BI, databases, CRM, etc.) and use it to create Roambi files.

How can I use the Roambi API with my data?

The Roambi API may be used to transport data from your existing data sources including BI systems, databases or CRMs and use it to create Roambi files.

The Roambi API may be used to automate the following functions:

  • Transport formatted source (Excel, CSV, HTML) files into the Roambi File System (RFS)
  • Create new RBI files from an existing template
  • Refresh existing RBI files with data
  • File viewer rights for Users or Groups

How does the Roambi API work?

Roambi API 1.0 exposes the Roambi File System (RFS) as the data storage system and enables users to import raw data from different sources and publish RBIs from it.

Roambi provides a RESTful API for programmatic access to your data on RFS. It uses JSON format for the data, OAuth for Authorization and Authentication. In designing the API, our goal was to make it simple, intuitive and predictable. We do our best to adhere to the following principles for our REST API.

Everything in the RFS is represented as an object with a defined structure. Whether it is a "folder" object that represents a storage destination, or an "user" object with "roles" and "access level", or even a collection of "files" that may be used to determine the content of the "folder", all aspects of Roambi API are modeled as structured objects.

What are the requirements to connect and publish with the Roambi API?

The Roambi API is data source and technology agnostic.  This means customers may develop a client application that interfaces with any data source in any language of their preference. 

Any developer who has experience in creating applications that require integration with an API platform (e.g. Facebook, Salesforce, Google Analytics, Box, etc.) should be immediately familiar with the Roambi API. 
 

Does the Roambi API require a specific programming language?

No. The Roambi API is data source and technology agnostic. Roambi Business customers may develop a client application that interfaces with any data source in any language of their preference. 

What are the Roambi API conventions?

All actions taken through the API are done via HTTP using standard HTTP verbs: GET (to retrieve an object),POST (to create), PUT (to modify), and DELETE.

Standard HTTP Response codes are used to indicate success and error conditions. Request body data is expected to be in JSON, and the response body data is returned as JSON. This API assumes that you have a good working knowledge of the Smartsheet application UI, concepts and terminology. Sample API calls are provided next to each method using cURL, a standard command line tool. All you need to do is drop in your specific parameters, and you can test the calls from the command line.

What is the Roambi API Input/Output format?

Both request body data and response data are formatted as JSON. Extremely large numbers will be returned in IEEE754 format (the same way doubles are stored in Java), e.g. 1.2318237429383e+31

What is the Roambi API Date format?

All timestamps (both those sent in requests and those returned in responses) should be formatted as ISO 8601.

How does the Roambi API ensure secure data transfer?

The Roambi API receives encrypted data and instruction via HTTPS allowing you to have 100% control over the granularity of the information transmitted, frequency of the updates, and the permission access to the data.

Article is closed for comments.