# 广告主API IN文档说明
HugOffers可以通过API集成实现自动化拉取offer，其中API-IN是针对广告主设置的api对接，目前系统内已经集合了500多家API对接模板供您使用。
与广告主进行API对接,需要相关信息，如API对接文档、完整的API url、参数说明等。
**添加API对接**
对于支持API的广告主，创建好广告主账号后，在导航栏 **Integration** 的 **API-IN Integration**页面点击 **Add** 创建对接并填写相应的信息。
**General**
**API Name**：API模板名称,确认广告主平台后，可在API Name中搜索平台名或广告主名。如果没有，可联系Hugoffers技术团队进行添加。
**Advertiser：**选择对接的广告主，前提是在 Advertiser 已经[添加广告主](https://www.yuque.com/hugoffers/support/how-to-create-an-advertiser)。
**API Status**：API对接状态，默认为Active。
**Default Payout(%)\*：**默认payout百分比，在广告主单价基础上所有offer的给到渠道的单价百分比。在offer授权方式为inherit时生效。
**Default Daily Cap：**每日的预计转化数量，-1 意味着cap没有上限。
我们提供以下选项供你选择：
* * Use\ , if not exist, use \ 使用广告主API的cap，如果广告主未设置cap，或者cap不存在，使用上面的Default Daily Cap。
* Ignore\ and use \ 忽略广告主API的cap，直接使用上面的Default Daily Cap。
* If \ equals 0, or not exist，use \ 如果API拉取的广告主的cap为0或者不存在，直接使用上面的Default Daily Cap。
**Goal Name：**需要选择类型，分为CPI\CPA\CPS\CPR\CPE
**Insert Limit：**指的是API拉取的offer的最大值，可以进行限制。
**Generate Url**
HugOffers会基于你选择的API模板自动生成Url Template，填入对应的参数（需要参考广告主的API文档），生成Result Urls。
以affise\_partner 模板为例
注意：系统配置了**翻页功能**，若广告主API单页限制了数量，模板链接没有page等页码参数，可在其中一个参数后面加\&page={page\[1-10]}；如有page参数，则page参数填入{page\[1-10]}。{page\[1-10]}代表拉取广告主接口的第1-10页内容。（使用翻页功能的链接在浏览器无法打开，但是系统可拉取）
**Permission**
在API-IN中Permission可以设置默认授权的渠道及cap、payout等相关信息。此处配置渠道即为该广告主的offer在拉取进系统时，就会默认授权给这些渠道。
Default Cap Percent 拥有最高权限，渠道的cap=Default Cap Percent\*Default Daily Cap ①，如果 Default Cap 广告主那里设置的是0，对应的渠道cap=Default Daily Cap ②
**Filter**
可添加过滤条件，来筛选想要的维度的单子。筛选维度包括国家、平台、激励类型、app种类、单价（开区间，非包含）。
完成后点击Submit保存
**View：**列表中可以看到API对接的具体信息。
Counts：API上一次拉取到的单子的数量。
Last Execute Date：API上一次拉取的具体时间。
**Search**：支持按照API名、广告主、渠道、状态维度索API
**Operate：**对已创建的API对接的操作选项。
Edit 可以修改这一条API的信息。
Inactive 和 active 可以关闭和开启 API.
Delete 将会从表中删除该条API。
注：如果你在Advertiser界面点击 “Account Block”，HugOffers系统将会自动把对应的API-IN处对接状态置为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/zhong-wen-shuo-ming-wen-dang/hugoffers-xiang-xi-shuo-ming-wen-dang/guang-gao-zhu-pian/guang-gao-zhu-api-in-wen-dang-shuo-ming.md?ask=
```
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.