If you have or plan on resetting your API key, make sure to review the following important considerations to make sure you get everything up and running as smoothly as possible!
In this article:
Integrations That Do Not Use Your API Key
Important Considerations
When resetting your API key, any custom built applications using your API key as well as some integrations will be impacted. You will need to reconnect these to your new API key to ensure everything is functioning as expected.
Never share your API key publicly. Your API key is a secret key that can give 3rd parties access to your site data.
How to Copy Your API Key
Once your API key is reset, you will need to navigate to your site settings to copy your new API key.
Learn how to copy your API key here.
Integrations That Do Not Use Your API Key
The following integrations do not use your API key. You do not need to take action on the following:
- Accredible
- ActiveCampaign
- AWeber
- Brillium
- Constant Contact
- ConvertKit
- Disqus
- Facebook Pixel
- Google Analytics 4
- Infusionsoft
- Mailchimp
- Mixpanel
- Paypal
- Shopify
- Stunning
- Stripe
- SUMO
- Zoom
Public API
If you have developed a private app or custom solution using your API key, you'll need to update your API key authentication. If you have worked with a developer or Thinkific Expert, make sure to reach out to them directly to make any necessary updates.
Learn more about authentication using your API key here.
Custom Single Sign-On (SSO)
This section is only relevant if you are using Thinkific's Custom SSO Implementation. There is no reset required if you are using OpenID Connect SSO.
If you currently have Custom Single Sign-On (SSO) set up for your site, it will no longer work when resetting your API key. You will need to update your SSO with your new API key.
In order to copy your new API key, you'll need to login to your Thinkific Admin Dashboard through thinkific.com. Not to worry if you have never done this before! Check out our instructions below to get started.
Learn how to login to your Thinkific Admin Dashboard without SSO here.
Learn more about setting up SSO here.
If you have worked with a developer or Thinkific Expert, make sure to reach out to them directly to make any necessary updates.
Webhooks
Your API key is used in the Webhooks API to create, update or delete webhooks. When resetting your API key, you will need to verify that any services that perform these actions with the Webhooks API are given access to the new API key. If you aren't sure, you may need to ask a developer to make this update.
The API key is also used to generate a hmac_header that is passed along with webhook events to allow you to verify that it originated from Thinkific. If your solution uses this verification as part of your response to incoming webhooks, you will need to ensure that you have updated the API key in order to properly verify the webhook accurately.
If you have worked with a developer or Thinkific Expert, make sure to reach out to them directly to make any necessary updates.
Learn more about webhooks here.
What is an API?
In computer programming, an Application Programming Interface (API) is a set of routines, protocols, and tools for building software applications. You can use an API to access databases or help to integrate and enhance the functionalities of an application.
You'll often need to access your API key when integrating with 3rd party applications. Your API key is also used when building custom solutions for your Thinkific site!