# Advertiser API IN Guide

HugOffers enables automated offer integration via API, where API-IN is designed for advertiser API connections. The system provides **500+ prebuilt API templates** for immediate use.

To integrate with an advertiser's API, you need:

* API documentation
* Complete API URL
* Parameter specifications

### **Adding an API Integration**

For API-supported advertisers:

1. Create an advertiser account.
2. Navigate to **Integration > API-IN Integration**.
3. Click **Add** to create a new integration.

#### **General Settings**

<figure><img src="https://1657844935-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lqy6ANIkDOJ0f2iOP3Z%2Fuploads%2FeE7BgzZ4W176dHoVlZlI%2Fimage.png?alt=media&#x26;token=d6bfe652-ae2c-4fac-a868-c208d0095110" alt=""><figcaption></figcaption></figure>

* **API Name**: Search for the advertiser/platform name. If unavailable, contact HugOffers support to add a template.
* **Advertiser**: Select the advertiser (must be [pre-added](https://www.yuque.com/hugoffers/support/how-to-create-an-advertiser)).
* **API Status**: Default is *Active*.
* **Default Payout(%)**: Base payout percentage for all offers under this API (applies when offer authorization mode is *inherit*).
* **Default Daily Cap**: Expected daily conversions. `-1` means no limit.

**Daily Cap Options**

a. **Use \<Api Daily Cap>**, if not exist, use \<Default Daily Cap>\
b. **Ignore \<Api Daily Cap>** and use \<Default Daily Cap>\
c. **If \<Api Daily Cap> equals 0 or not exist**, use \<Default Daily Cap>

* **Goal Name**: Select type (CPI/CPA/CPS/CPR/CPE).
* **Insert Limit**: Maximum number of offers to pull via API.

#### **Generate URL**

HugOffers auto-generates a **URL Template** based on the selected API. Fill in parameters (refer to the advertiser's API docs) to generate **Result URLs**.

<figure><img src="https://1657844935-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lqy6ANIkDOJ0f2iOP3Z%2Fuploads%2FJL4o92rQIuPolA7BOb9e%2F2.png?alt=media&#x26;token=77e932a3-c3d7-403d-870d-816193abcd09" alt=""><figcaption></figcaption></figure>

**Note**:

* Use `&page={page[1-10]}` if the API limits results per page but lacks pagination parameters.
* `{page[1-10]` fetches pages 1-10 (links are system-only and not browser-testable).

#### **Permissions**

Configure default authorized affiliates, caps, and payout rules. Offers pulled via this API will auto-authorize these affiliates.

<figure><img src="https://1657844935-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lqy6ANIkDOJ0f2iOP3Z%2Fuploads%2F4RZmhxhQPoj5zSsFWSxG%2F3.png?alt=media&#x26;token=996daeb1-9d08-465e-ba46-c83eb8248626" alt=""><figcaption></figcaption></figure>

* **Default Cap Percent**: Highest priority. Affiliate cap = `Default Cap Percent × Default Daily Cap` ①. If the advertiser's cap is `0`, affiliate cap = `Default Daily Cap` ②.

<figure><img src="https://1657844935-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lqy6ANIkDOJ0f2iOP3Z%2Fuploads%2FzlPsmHWnJYuxkkVHNB5X%2F4.png?alt=media&#x26;token=97a10dac-f811-40da-a9c0-9cef43039657" alt=""><figcaption></figcaption></figure>

#### **Filters**

Add filters to screen offers by:

* Country
* Platform
* Incentive type
* App category
* Payout (open intervals, non-inclusive).

<figure><img src="https://1657844935-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lqy6ANIkDOJ0f2iOP3Z%2Fuploads%2FpmEireAG3KQB717LC1Ih%2F5.png?alt=media&#x26;token=642fc061-e7ef-4021-8254-eb8e0aa98769" alt=""><figcaption></figcaption></figure>

Click **Submit** to save.

#### **View & Manage Integrations**

* **Counts**: Number of offers pulled in the last API fetch.
* **Last Execute Date**: Timestamp of the last API pull.
* **Search**: Filter by API name, advertiser, affiliate, or status.

**Operate Options**

* **Edit**: Modify API settings.
* **Inactive/Active**: Toggle API status.
* **Delete**: Remove the API integration.

**Important**: Clicking "Account Block" on the Advertiser interface sets the API status to *Inactive*.