This article will cover the following:
- What is an API Key?
- Different types of API's
- Where do I find my Admin API Key
- Why would I want to add API Keys
- API Library
What is an API Key?
Before we answer that question, it's better to ask "What is an API?"
First, API stands for Application Programming Interface. Simply put this just means that an API is a way for two systems to communicate with each other.
In our case API's are used for external systems to communicate with CAKE.
So, what is an API key? Because API's can be very powerful, most require a unique password to allow the API to be accessed and function - That password is the API key.
An API Example
As mentioned API's can be used in different ways, even altering important information within your CAKE instance. This can be anything from conversion data to entire entities.
The example above is an API that can be used to create or edit offers within your system.
Notice that the first required parameter to make this API function is the API key. Without the correct API key the API will not work.
Different Types of API's
The example above is classified as an Admin API. This means that the functionality produced by the API can edit data within your Admin interface. In that particular example, an offer.
CAKE also has API's specific to your affiliates - called Affiliate API's. These can be found within our Affiliate API Library or the affiliate can access them directly from within the Affiliate Portal. Advertisers also have access to API's through the Advertiser Portal and even buyers have limited API's to pull reports and modify leads and each set of API's require an admin API key, affiliate API key, etc.
Where do I find my Admin API Key?
Your CAKE instance was populated with a default API Key which can be accessed from within the Admin interface.
To find it, click on Setup > Permissions > API Keys.
You can additionally add extra API keys here as well.
Why would I want to add API Keys?
There are several reasons why you may need to provide your API Key to a third party, but the most common is to allow Fraud Detection companies to access information which they need to score your conversions.
But even among employees, you may want to create additional API keys to be able to monitor which API's are being used by which employees or teams. Should any API activity look suspect, having individual API keys gives you the ability to shut off the API keys tied to the suspicious or unauthorized activity.
All API keys including your default can have a start date and an end date which means they will only work within that timeframe. \L Regardless of the start and end dates, you can choose to make an API key active or inactive at any time.