Sapling - Creating API Keys

Introduction

What Is an API?
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, which allow other apps to access your account without you giving out your password. IT teams can use our API documentation to learn how to use our APIs.

This article covers the following topics:

• Locating and Generating New API Keys
• Disabling Keys
• Pro Tips

Locating and Generating New API Keys

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.

1. Go to the “Integrations” page of your Sapling account
2. Navigate to the API Keys tab 
3. Copy an existing API key, or click on the “Create New Key” button
4. Be sure to name your key descriptively, so you know how each application uses that key

Disabling Keys

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 disable that API key. 

Follow the steps below to disable the API key.

1. Go to the “Integrations” page of your Sapling account
2. Navigate to the API Keys tab 
3. Toggle the switch to turn off the key
   Keep in mind that if a key is deleted, it cannot be restored.

 

Pro Tips

• API Key expires in 90 days. 
• The keys can be set to renew based on usage, so if an API key is used, it can be refreshed for another 90 days.