Search API Connector Documentation

Print

Create a Request

API Connector includes a built-in directory of popular and interesting APIs. For this quick start, we’ll fetch data from one of the preset integrations available through the directory.

If you’d prefer to create your own custom API request, please check this article: Create a Custom Request

Contents

Before You Begin

Click here to install the API Connector extension from the Google Marketplace.

Step 1: Open the Sidebar

After installing the plugin in Google Sheets, click Extensions > API Connector > Open

Step 2: Add a New Request

Once the sidebar opens, click Create request to start a new request.
quickstart-create-request

Step 3: Select an API

To access the directory, browse or search for an application in the application menu.

This image has an empty alt attribute; its file name is api-library-search.jpg

Step 4: Set Authentication

Authentication requirements will vary by API:

  • Open APIs don’t require any authentication at all. They are marked with a green “unlocked” icon.
    api-library-unlocked
  • OAuth APIs can be connected to by clicking a blue Connect button.
    premium
    api-library-connect-button
  • Some APIs require header keys or tokens. In these cases, enter the value into the input field. Additional instructions are provided in the Auth Info link.
    api-library-auth-info
  • Some APIs use query string parameters. These can be entered in the parameters section.

Step 5: Select an Endpoint

Each API’s data is organized into endpoints, which can be thought of as individual data sets or tables. Select an endpoint from the dropdown menu.

This image has an empty alt attribute; its file name is api-library-endpoints.jpg

Step 6: Set Parameters

All available parameters will appear below the associated endpoint. Any required parameters will be marked as such, while other parameters can optionally be used to filter and customize the response data.

api-library-parameters

Step 7: Set Destination Sheet

Enter a destination sheet or click Set current to send the response data to the currently focused cell.

This image has an empty alt attribute; its file name is api-library-destination.jpg

Step 8: Choose Output Options

(optional) Click the Output options button and customize your request. Options include setting the output mode to overwrite vs. append, choosing a report style, applying pagination, and more.
customrequest-options

Step 9: Edit Fields

(optional) Click the Edit Fields button to preview your request. This will bring up a preview window where you can map fields to specific columns and choose which fields to display in your sheet.
customrequest-editfields

For more information on the visual field editor, see here: Edit Fields

Step 10: Name and Run

Give your request a name and click Run.

This image has an empty alt attribute; its file name is api-library-run.jpg

Questions?

Please leave a comment below, contact support, or leave a message in the API Connector user community. You’ll receive a response shortly.



Next Edit Fields

3 thoughts on “Create a Request”

  1. Hi Ana
    Great Add on to Sheets, Thanks a lot for providing!
    I d like to use API Connector with my Kraken Account. I have created a API privat Key there. But now using it, trying to find the url and the right way to paste the PRIVATE Key the in the correct fields. Can You help?

    Reply
    • Hi there, Kraken’s API requires a more complex form of authentication than a key to access private data, you can see their requirements here. They require that you apply the HMACSHA512 hashing algorithm to a signature generated with your private key, nonce, encoded payload, and URI path. So you’ll need a script or connector developed for Kraken as we dont have native support for that, sorry.

      Reply

Leave a Comment

Table of Contents