API Keys are used by programs to retrieve data directly from Affelios without the need to scrape the data manually from the Affelios dashboard. This guide will briefly show you how to create API keys and help you understand as a user how API keys are scoped so that you know how to best manage API access for your programs.
API Keys at minimum require the "API Keys" permission. If you are an affiliate, you should request this permission be granted to your account from your program manager.
If you are an operator, be assured that affiliates will only view or be able to modify their own keys when this permission is assigned.
To create API Keys, you'll need to first go to your settings and select "API Keys."
You will then be able to create new API Keys by clicking the "Create API Key" button.
You'll be able to assign different permissions to your API Keys depending on their use case. You will only be able to assign permissions to your API key from within the scope of permissions your user possesses on the related program.
You'll generally want to avoid assigning all read/write permissions and keep API key permissions limited to their required purpose.
Once you've created your API Key, it will be presented to you as shown below:
You'll need to copy and store this key somewhere before moving on, as you will not be able to retrieve this key again at a later time. Instead, you'll need to create a new one.
This API key can be used to access Affelios various APIs for retrieving data. API Keys are scoped to an individual user and thus can see any data that the user has read-access to. A list of permissions can be found here.
WARNING! Program managers should avoid creating API keys for it's users and instead grant them access to create their own API keys limiting the data they can retrieve to only their data. If a user has admin access, they'll be allowed to view all data within a program.
You can visit our API Documentation here for more information on how to use API keys to request data from Affelios.