VOOZH about

URL: https://www.cdata.com/kb/tech/paypal-odata-infragistics-reveal.rst

⇱ Analyze PayPal Data in Infragistics Reveal


Analyze PayPal Data in Infragistics Reveal

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use the CData API Server to create an OData API on top of PayPal data and visualize live PayPal 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 PayPal data. The CData API Server generates an OData API for PayPal, which is natively consumable in Reveal. In this article, we walk through connecting to PayPal in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.

Connect to PayPal from API Server

CData API Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Open API Server and click Settings -> Connection -> Add Connection πŸ‘ Adding a connection
  2. Select "PayPal" πŸ‘ Selecting a Connector (Salesforce is shown).
  3. Enter the necessary authentication properties to connect to PayPal.

    The provider surfaces tables from two PayPal APIs. The APIs use different authentication methods.

    • The REST API uses the OAuth standard. To authenticate to the REST API, set the OAuthClientId, OAuthClientSecret, and CallbackURL properties.
    • The Classic API requires Signature API credentials. To authenticate to the Classic API, obtain an API username, password, and signature.

    See the "Getting Started" chapter of the help documentation for a guide to obtaining the necessary API credentials.

    To select the API you want to work with, you can set the Schema property to REST or SOAP. By default the SOAP schema will be used.

    For testing purposes you can set UseSandbox to true and use sandbox credentials.

    πŸ‘ Configuring a connection (Salesforce is shown).

Add PayPal Resource Definitions in API Server

After connecting to PayPal, create Resources, which represent API endpoints for PayPal data.

  1. Click Settings -> Resources -> Add Resource πŸ‘ Adding a new resource
  2. Select the PayPal connection πŸ‘ Selecting a connection (Salesforce is shown)
  3. Select the table you wish to retrieve and click Next πŸ‘ Selecting a Table (Salesforce is shown)
  4. (Optional) Edit the resource to select specific fields and more
  5. Save the settings

Add an API Server User

Create a User to connect to PayPal from Reveal through API Server.

  1. Click Settings -> Users
  2. Click Add
  3. Configure a User with access to the PayPal Connection and Resource(s) πŸ‘ Creating a new user
πŸ‘ API Server users

(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.

πŸ‘ Configuring CORS settings

Create a Dashboard in Reveal

With the API Server configured, we can visualize PayPal data in Reveal.

  1. Log into Reveal and click Dashboards -> New πŸ‘ Adding a new dashboard
  2. Click Data Source -> OData Feed πŸ‘ Adding a new OData data source
  3. Specify the API Server API endpoint URL, for example: https://serverurl/api.rsc πŸ‘ Configuring the OData URL
  4. Select Generic Credentials and specify the API Server username and authentication token πŸ‘ Configuring the credentials
  5. Select the entity you wish to visualize πŸ‘ Selecting an entity to visualize (Salesforce is shown.)
  6. Select fields and choose a chart type πŸ‘ Visualizing data in Reveal (Salesforce is shown.)

More Information & Free Trial

At this point, you have created a simple dashboard from live PayPal data. For more information on creating OData feeds from PayPal (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live PayPal data in tools that consume OData APIs.