API Data Provider - Online Help

Connecting to Humanity

Humanity uses OAuth-based authentication to enable access to your data.

Using Oauth Authentication

In order to authenticate to Humanity, you will first need to create an application from the page 'Settings' > 'API V2'. Your OAuth app will be assigned an App ID and App Secret. Those credentials can be used to authenticate. After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
  • OAuthClientID: Set this to the App ID that is specified in you app settings.
  • OAuthClientSecret: Set this to the App Secret that is specified in you app settings.
  • User: Set this to your user email address.
  • Password: Set this to your account's password.

Example Connection String

Profile=C:\profiles\Humanity.apip;Authscheme=OAuth;InitiateOAuth=GetAndRefresh;OAuthClientId=my_app_id;OAuthClientSecret=my_app_secret;User=my_email;Password=my_password;

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
AuthScheme The scheme used for authentication. Accepted entries are None or OAuth.
Allowed values are: NONE, OAUTH
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Allowed values are: OFF, GETANDREFRESH, REFRESH
OAuthClientId The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.
Password The password used to authenticate the user.
User The API user account used to authenticate.

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