What is API and how to use it in HilltopAds?
API stands for Application Programming Interface. In simple terms, it is a set of protocols, tools, and methods that allow different software applications to communicate and interact with each other. APIs are typically used to facilitate the exchange of data and functionality between various applications, platforms, and systems.
The HilltopAds API is a set of methods that enable advertisers to interact with the HilltopAds ad network. It serves as a software interface through which various processes related to managing advertising campaigns, retrieving data, and other operations on the platform can be automated.
What request methods are used?
The HilltopAds API for advertisers supports GET, PATCH, POST, DELETE, and PUT methods.
GET method allows you to retrieve data without making any changes.
PATCH method allows you to update the data provided in the request.
POST method allows you to create data.
DELETE method allows you to remove data.
PUT method allows you to replace all the data provided in the request.
Please note that PATCH and PUT methods work similarly, but there is a difference in their operation, which will become clear through an example.
Let's say we have data {A:1, B:2, C:3}. We need to replace B:2 with B:4.
The PATCH method will only replace the B parameter. As a result, we will get {A:1, B:4, C:3}.
The PUT method will replace ALL parameters. As a result, we will get {B:4}.
How to generate an API Key?
To start working with the API, you need to generate your API key. To do this:
Login to HilltopAds personal account.
Navigate to the My Account section.
Then go to the API tab.
Provide a description for the API key.
Click on the Generate API key button.
This API key is a unique code that will associate your API request with your account and enable the function to work specifically with your data.
Please note that to ensure the API requests to the methods work correctly, make sure that the API key you generated has an Active status.
