User guideAPI authentication
Account identifiers
Account identifiers are entities that help you uniquely identify your Kissflow account while making API calls. You can identify your Kissflow account either by its ID or domain name.
Account ID
Account ID is a unique alphanumeric key that distinguishes your Kissflow account from other accounts. You can copy the Account ID and use it for your API sessions while establishing secured connections.
Account domain
Account domain is your domain address with which you can directly access your Kissflow account on your web browser.
Debug session key
If there is an issue with your account, Kissflow might need your Debug session key to troubleshoot the issue. Click Show under Debug session key to view your unique key. Copy this key and share it with the Kissflow team to facilitate troubleshooting.
API keys
An API key is a unique identifier that authenticates requests associated with your Kissflow account. API key authentication is the simplest and primary form of authentication in Kissflow. However, we have moved to the access key authentication system recently to provide better security in terms of authenticating API calls.
If you are already using API keys, we recommend you create their equivalent access keys as necessary before we deprecate them.
Troubleshooting API keys
- Is there a deadline before which I have to create the equivalent access keys for my current API keys?
Yes, we will be deprecating the current API keys across the Kissflow accounts on or after 15th July 2023. We recommend you delete the existing keys and create their equivalents or new ones under the access key authentication system as soon as you can. - I am unable to create a new API key. How do I create one?
Sorry, as we have already moved to the access key authentication system, we do not encourage the creation of new API keys anymore. We will only continue to support your existing keys until their deprecation which is scheduled to happen on or after 15th July 2023.
Deleting an API key
- Navigate to the API key you would like to delete and click the More options button (
). - Click Delete to delete it permanently.
Access keys
An access key is a unique identifier that is used to authenticate a user, developer, or calling program to an API. Each access key will have an access ID and a secret key i.e. an ID-secret pair that lets you obtain programmatic access to Kissflow.
Creating a new access key
- Click your profile picture > My settings > API authentication > Access keys
- Click Create access key
- Enter the name of the access key
- Set an appropriate expiry period for the key. Learn more about the expiry period and how to configure it at the account level here.
- Click to copy the access key ID and access key secret and store them in your preferred location on your computer or click Download credentials to store them directly as a file.
- Click Done after downloading the access key credentials
- Click Proceed to confirm your action after reading the alert message. Your access key is successfully created now.
Please note that anyone who has your access key and access secret will be able to perform the same operations as you or the specific Kissflow user can. This is why it is extremely important not to share the credentials with anyone.
Accessing a system-generated access key
- Click your profile picture > My settings > API authentication > Access keys
- Select the Show system-generated checkbox to view the list of system-generated access keys. These keys are created through Kissflow's Integrations.
- They are hidden by default, and you have to select this checkbox to view them. They are also distinguished by a System flag beside their name and placed first in the list to help you differentiate these keys from the rest.
Managing an access key
- Navigate to the access key you would like to rename or delete and click the More options button ( ).
- Click Rename to modify the name of the access key and click Delete to delete it permanently.
Note:
When you delete an access key, the connections established using the key will be revoked automatically.