# 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="/files/0IjfnotXzNv4uaCEihMd" 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="/files/PNJHPOSNtCdeKVyr7Y9u" 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="/files/JfMoSd6dLU5T6QXTA08T" 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="/files/gNENUB6gge6j9EOuHJ4a" 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="/files/AUBAF6iO98ttt9odhahT" 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*.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://support.hugoffers.com/hugoffers-reference-guide/baisc/advertiser-api-in-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.