Klipfolio uses authentication to allow us to connect to data from web services.
Each web service has unique definitions and requirements for their APIs. Always start by referring to the API documentation for the web service you are connecting to for specific details.
Note: Some data connections don’t require any authentication.
Types of authentication include:
- OAuth Token authentication
- API Key authentication
- Basic HTTP authentication
- 2-Step authentication
- Signed Authentication Builder (Hash Helper)
OAuth Token authentication
The OAuth Token authentication method is an open standard authentication that is used when retrieving data from web services. In Klipfolio, OAuth tokens are generated as part of the data connection workflow, where you will typically be asked to enter your credentials for the web service. Your tokens are then stored in your Klipfolio account.
For more information on managing your OAuth tokens, click here.
Learn more about OAuth Token authentication and how to authenticate with this method here.
API Key authentication
The API Key authentication method uses generated authentication tokens to perform API calls. Often called API Keys or API Tokens, these authentication keys are typically generated from the service provider and are included in the request URL.
Learn more about API Key authentication and how to authenticate with this method here.
Basic HTTP authentication
The Basic HTTP authentication method uses valid service credentials as part of the API call. In most cases, authentication requires a username and password.
Learn more about Basic HTTP authentication and how to authenticate with this method here.
2-Step authentication
The 2-Step authentication method uses an authentication key in the request URL and your service credentials to generate a unique authentication key.
Learn more about 2-Step authentication and how to authenticate with this method here.
Signed Authentication Builder (Hash Helper)
Some third-party APIs require a signed authentication parameter to be included in their API query to secure the identity of the user. A signed authentication parameter is comprised of one or more data elements, such as an API key or a user ID, that have been encrypted to produce a unique key.
Learn more about Signed Authentication Builder (Hash Helper) and how to authenticate with this method here.