VOOZH about

URL: https://www.cdata.com/kb/tech/api-cloud-excel-desktop.rst

⇱ Access Live API Data in Excel (Desktop) via Connect AI


Access Live API Data in Excel (Desktop) via Connect AI

πŸ‘ Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
Use CData Connect AI to gain access to live API data from your Excel spreadsheets.

Microsoft Excel is a widely used spreadsheet software application, primarily used for tasks related to data management, analysis, and visualization. When combined with CData Connect AI, you gain immediate access to API data directly within Excel, facilitating data analysis, collaboration, calculations, and more.This article shows how to connect to your API in your Connect AI instance and access and update live API data in Excel spreadsheets.

CData Connect AI provides a pure cloud-to-cloud interface for your API, allowing you to easily access live API data in Excel for the web. Simply use the Connect AI Add-In to query live data (or write your own). Using optimized data processing out of the box, CData Connect AI pushes all supported query operations (filters, JOINs, etc) directly to your API, leveraging server-side processing to quickly return API data.

This setup requires a CData Connect AI instance and the CData Connect AI Add-In for Excel. To get started, sign up a free trial of Connect AI and install the free Connect AI Excel Add-In.


Configure your API Connectivity for Excel

Connectivity to your API from Excel is made possible through CData Connect AI. To work with API data from Excel, we start by creating and configuring a your API connection.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. πŸ‘ Adding a Connection
  3. Select "API" from the Add Connection panel
  4. πŸ‘ Selecting a data source
  5. Enter the necessary authentication properties to connect to your API.

    To connect to your API, configure the following properties on the Global Settings page:

    • In Authentication, select the Type and fill in the required properties
    • In Headers, add the required HTTP headers for your API
    • In Pagination, select the Type and fill in the required properties

    After the configuring the global settings, navigate to the Tables to add tables. For each table you wish to add:

    1. Click "+ Add"
    2. Set the Name for the table
    3. Set Request URL to the API endpoint you wish to work with πŸ‘ Setting the Request URL (Harvest is shown)
    4. (Optional) In Parameters, add the required URL Parameters for your API endpoint
    5. (Optional) In Headers, add the required HTTP headers for the API endpoint
    6. In Table Data click " Configure"
    7. Review the response from the API and click "Next" πŸ‘ Reviewing the API response (Harvest is shown)
    8. Select which element to use as the Repeated Elements and which elements to use as Columns and click "Next" πŸ‘ Configuring the schema based on the API response(Harvest is shown)
    9. Preview the tabular model of the API response and click "Confirm" πŸ‘ Previewing the tabular model of the API response (Harvest is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add your API Connection page and update the User-based permissions. πŸ‘ Updating permissions

With the connection configured, you are ready to connect to API data from Excel.

Access Live API Data in Excel

The steps below outline connecting to CData Connect AI from Excel to access live API data.

  1. Open Excel, create a new sheet (or open an existing one).
  2. Click Insert and click Get Add-ins. (if you have already installed the Add-In, jump to step 4).
  3. Search for CData Connect AI Add-In and install the Add-in. πŸ‘ Install the Add-In
  4. Click Data and open the CData Connect AI Add-In.
  5. In the Add-In panel, click Authorize to authenticate with your CData Connect AI instance πŸ‘ Authorizing the Add-In
  6. In the CData Connect AI panel in Excel, click Import πŸ‘ CData Connect AI panel in Excel
  7. Choose a Connection (e.g. API1), Table (e.g. posts), and Columns to import πŸ‘ CData Connect AI panel in Excel
  8. Optionally add Filters, Sorting, and a Limit πŸ‘ Choosing a Connection, Table, and Columns
  9. Click Execute to import the data πŸ‘ Executing the Query

Update API Data from Excel

In addition to viewing API data in Excel, CData Connect AI also lets you update and delete API data. Begin by importing data (as described above).

  1. Update any cell or cells with changes you want to push to your API (your changes will be in red)
  2. In the CData Connect AI Add-In panel, select Update
  3. Optionally highlight the cell(s) you wish to update and select an update option ("Update All" or "Update Selected") πŸ‘ Executing the update (Salesforce is shown).
  4. Click Execute to push the updates to your API, and a notification will appear when the update is complete
  5. Live Access to API Data from Cloud Applications

    Now, you have a direct, cloud-to-cloud connection to live API data from your Excel workbook. You can add more data to your workbook for calculations, aggregations, collaboration, and more.

    πŸ‘ Imported data (Salesforce is shown)

    Try CData Connect AI and get real-time data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications.