Excel Add-In for Highrise

Build 24.0.9060

Establishing a Connection

Configure a Connection Profile

From the CData ribbon, click Get Data and select From Highrise connection/s to launch the CData Query window. To setup a new connection, you will have to click the New Highrise Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Authenticating to Highrise

Highrise supports OAuth and API token authentication schemes.

OAuth

Highrise uses the OAuth authentication standard. To authenticate to Highrise, you need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL.

In all OAuth flows, you must set AuthScheme to OAuth. The following sections assume you have done so.

Desktop Applications

CData provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

  • OAuthClientId (custom applications only): Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your application.
  • CallbackURL (custom application only): Set this to the redirect URI defined when you registered your application.
When you connect, the add-in opens Highrise's OAuth endpoint in your default browser. Log in and grant permissions to the application. The add-in refreshes the access token automatically when it expires.

API Token

To authenticate to Highrise with an API token, set the following:

  • AuthScheme: Set AuthScheme to APIToken.
  • APIToken: The APIToken of the user. To obtain your API token, log in to your Highrise account and click the My Info link. If you are an admin or a user, this is located under the "Settings" section of the account. See Find Your API Token in the Highrise documentation for more information.
  • AccountId: The Account Id of the user.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to Highrise you will be able to customize the data you are importing. To learn more about this, see Managing Connections.

See Also

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060