Skip to main content

Sapling - Create an API Key

Bolaji Elusogbon
Updated

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

If you want to set up a custom 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. Click on the "Create New Key" button, or copy an existing key.
  4. Be sure to name your key descriptively, so you know how each application uses that key
  5. Select whether you would like the API key to expire after 90 days or automatically renew when used.
  6. Click "Create", then copy your new API key. Once you click "Save" you will no longer have access to the key itself.

Screen_Shot_2023-05-16_at_8.45.34_AM.png

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.

API Key Expiry

By default, API keys are set to expire every 90 days and there is no way to manually refresh an API key for another period. This increases the security for custom integrations, and ensures that if any API keys have been compromised that they will expire within a set period.

If you would like the API keys you are actively using to not expire while they are still in use, when creating an API key, select the box that says"Automatically renew the API key when a call is made to that key." API keys that have this option selected will still expire after 90 days unless they are actively being used. Every time an API key is used, the 90-day countdown clock refreshes. This allows unused API keys to expire while allowing your team to avoid creating new API keys every 90 days when you have an active integration. 

Related articles