How to use an API key to grant access to integrations with your Sapling account.
API stands for Application Programming Interface. It can be helpful to think of the API as a way for different apps to talk to one another.
For many people, the main interaction with the API will be through API keys. Creating API keys allows other apps to access your account without you giving out your password.
If you want to set up an integration with your Sapling account, you’ll likely need to generate an API Key. Users with Super Admin permissions can generate and view their own API keys.
To create a new API key, navigate from Home > Integrations > API keys. From here, you can copy an existing API key, or click "Create New Key" for a new integration. Be sure to name your key descriptively, so you know how each application uses that key.
Because an API key has the ability to access so much mission critical data, as a safety precaution they only last for 90 days. At the end of 90 days, you will need to generate a new key to continue to allow access to the Sapling API. Don't worry though - we'll warn you when your key is nearing the 90 day mark so you won't get caught by surprise.
If you're worried that an API key has been compromised, or you no longer use the integration that was accessing your account through a particular API key, you can immediately disable that API key.
To do this, navigate from Home > Integrations > API Keys. Click on the trash can next to the API Key to delete it.
*Note: Keep in mind that if a key is deleted, it cannot be restored.