Analyze Reply.io Data in Infragistics Reveal
Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live Reply.io data. The CData API Server generates an OData API for Reply.io, which is natively consumable in Reveal. In this article, we walk through connecting to Reply.io in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.
Connect to Reply.io from API Server
CData API Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.
- Open API Server and click Settings -> Connection -> Add Connection
- Select "Reply.io"
- Enter the necessary authentication properties to connect to Reply.io.
The Reply.io API uses API Key authentication via the x-api-key request header.
Using API Key Authentication
Your Reply.io API key is required to create a connection. To obtain your API key:
- Log into your Reply.io account.
- Click your profile icon and select Settings.
- Navigate to the API section.
- Copy your API Key.
After obtaining your API key, set the following connection properties:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Reply.io API key.
- UserEmail (optional): Set this to the email address of the Reply.io user on whose behalf requests are made.
Example connection string:
Profile=C:\profiles\ReplyIO.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
Add Reply.io Resource Definitions in API Server
After connecting to Reply.io, create Resources, which represent API endpoints for Reply.io data.
- Click Settings -> Resources -> Add Resource
- Select the Reply.io connection
- Select the table you wish to retrieve and click Next
- (Optional) Edit the resource to select specific fields and more
- Save the settings
Add an API Server User
Create a User to connect to Reply.io from Reveal through API Server.
- Click Settings -> Users
- Click Add
- Configure a User with access to the Reply.io Connection and Resource(s)
(Optional) Configure Cross-Origin Resource Sharing (CORS)
When accessing and connecting to multiple different domains from an application such as Ajax, there is a possibility of violating the limitations of cross-site scripting. In that case, configure the CORS settings in Settings -> Server.
- Enable cross-origin resource sharing (CORS): ON
- Allow all domains without '*': ON
- Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
- Access-Control-Allow-Headers: Authorization
Save the changes to the settings.
Create a Dashboard in Reveal
With the API Server configured, we can visualize Reply.io data in Reveal.
- Log into Reveal and click Dashboards -> New
- Click Data Source -> OData Feed
- Specify the API Server API endpoint URL, for example: https://serverurl/api.rsc
- Select Generic Credentials and specify the API Server username and authentication token
- Select the entity you wish to visualize
- Select fields and choose a chart type
More Information & Free Trial
At this point, you have created a simple dashboard from live Reply.io data. For more information on creating OData feeds from Reply.io (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live Reply.io data in tools that consume OData APIs.