Прежде чем начать
API для предложений
API Affise предоставляет вам множество методов для работы с предложениями: вы можете получить информацию или добавить/изменить/удалить ее. С помощью API вы можете управлять своими предложениями, начиная с предоставления аффилиатам возможности добавить одно или несколько правил шапки. В этой статье вы найдете примеры наиболее популярных API-запросов (методов) для предложений с примерами cURL и ответами.
Список офферов
Используйте этот метод, чтобы получить список офферов в соответствии с их свойствами, которые вы можете указать в своем API-запросе.
Метод: GET /3.0/offers.
Запрос для получения предложений со статусом Active:
https://api-rocketcompany.affise.com/3.0/offers?api-key=4sdf87fsdfd8723lkjhrn324&status[]=active
Добавить предложение
Используйте этот метод для добавления предложения в панель администратора. В документе API указаны общие параметры, а также параметры типа массив для:
выплат
целевые страницы
шапки
уровни комиссии
группы таргетинга
дополнительные URL-адреса отслеживания
структура ОС
HTML-креативы
график предложений
Все эти типы данных имеют обязательные параметры:
один основной параметр для каждого типа
обязательный параметр(ы) внутри каждого массива (отмечены * в документе API)
🔎 Список основных параметров для каждого типа данных:
платежи: для выплат
лендинги: для посадочных и предпосадочных страниц
крышки: для крышек
commission_tiers: для уровней комиссии
таргетинг: для групп таргетинга
расписание: для расписания предложений
creativesHtml: для HTML-креативов
🔎 Обязательными параметрами для создания предложения являются:
название
рекламодатель
url
платежи
Если вы не знаете, какие значения добавить (например, коды ISO для стран), используйте методы отсюда и отсюда, которые помогут получить список доступных значений.
Метод: POST /3.0/admin/offer
Запрос cURL для добавления предложения со следующими свойствами:
статус Active.
уровень конфиденциальности Private.
выбранный флажок CPI.
примечание.
одна общая группа таргетинга для Франции, Германии и Италии, для Android >= 6.0.0.
одна общая выплата для тех же стран, фиксированный тип выплаты в USD.
одно правило лимита на 1000 конверсий для таймфрейма = месяц, цель = все, аффилиаты = все.
две целевые страницы.
curl --request POST \ --url https://api-rocketcompany.affise.com/3.0/admin/offer \ --header 'api-key: 4sdf87fsdfd8723lkjhrn324' \ --header 'content-type: application/x-www-form-urlencoded' \ --data 'title=New Offer' \ --data advertiser=62fcd7ae7a3ccd7eacd7e4eb \ --data 'url=http://new-tracking-link.network.com?clickid={clickid}' \ --data status=active \ --data privacy=private \ --data is_cpi=1 \ --data 'notes=It is the newest offer' \ --data 'targeting[0][country][allow][0]=FR' \ --data 'targeting[0][country][allow][1]=DE' \ -...-data 'targeting[0][country][allow][2]=IT' \ --data 'targeting[0][os][allow][0][name]=Android' \ --data 'targeting[0][os][allow][0][comparison]=GTE' \ --data 'targeting[0][os][allow][0][version]=6.0.0' \ --data 'payments[0][countries][0]=FR' \ --data 'payments[0][countries][1]=DE' \ --data 'payments[0][countries][2]=IT' \ -...-data 'payments[0][currency]=USD' \ --data 'payments[0][type]=fixed' \ --data 'caps[0][period]=month' \ -...-data 'caps[0][type]=conversions' \ --data 'caps[0][value]=1000' \ --data 'caps[0][goal_type]=all' \ --data 'caps[0][affiliate_type]=all' \ --data 'landings[0][title]=Dating online' \ --data 'landings[0][url]=http://new-tracking-link.network.com?clickid={clickid}&sub1=online'\ --data 'landings[0][url_preview]=http://new-tracking-link.network.com/online'\ --data 'landings[1][title]=Dating offline'\ --data 'landings[1][url]=http://new-tracking-link.network.com?clickid={clickid}&sub1=offline'\ --data 'landings[1][url_preview]=http://new-tracking-link.network.com/offline'⚠️ Убедитесь, что вы соблюдаете все требования к типу данных массива, включая скобки и нумерацию.
Добавление предложения с логотипом или креативами
Используйте этот метод, чтобы добавить предложение с логотипом или креативом. В дополнение к обязательным параметрам, которые были упомянуты ранее, вы можете добавить следующие:
creativeFiles
creativeUrls
creativeDownloads
creativesHtml
creativeAssets
creativeFileTitles
creativeUrlTitles
creativeDownloadTitles
логотип
⚠️ Если вы создаете предложение вручную через API и хотите добавить логотип или креативные файлы/загрузки, убедитесь, что вы используете следующий заголовок content-type: multipart/form-data.
Запрос может выглядеть следующим образом:
Вы можете посмотреть демонстрацию того, как добавить файл с логотипом:
Запрос cURL для создания предложения с логотипом и креативами:
curl --location --request POST 'https://api-rocketcompany.affise.com/3.0/admin/offer'\--header 'Content-Type: application/x-www-form-urlencoded'\--header 'Content-Type: multipart/form-data'\--header 'api-key: bf09c801ff9b95b14ac8e17d6e4904b6' \--form 'title=OFFER WITH LOGO AND CREATIVES' \--form 'advertiser=5e39279bac611cda7e5765ab' \--form 'url=https://track.gjane.com/hc/click?afclick={clickid}&afpid={pid}&afoffer={offer_id}'\--form 'logo=@/C:/Users/37525/Downloads/api.png'\--form 'creativeFiles[0]=@/C:/Users/37525/Downloads/api.png'\--form 'creativeUrls[1]=https://google.drive'\--form 'creativeDownloads=https://google.drive/download'\Редактирование предложения
Используйте этот метод для редактирования предложения: всех настроек или только части предложения. Перед использованием этого метода рекомендуем прочитать статью о редактировании типа данных массива.
Метод: POST /3.0/admin/offer/{ID}
Запрос cURL для редактирования группы таргетинга в том же предложении, которое используется в качестве примера для добавления предложения. В примере было изменено следующее:
Франция, Германия и Италия были заменены на Исландию и Ирландию.
Версия ОС была изменена на 7.0.0.
был включен прокси-инструмент для борьбы с мошенничеством.
curl --request POST \ --url https://api-rocketcompany.affise.com/3.0/admin/offer/1441594 \ --header 'api-key: 4sdf87fsdfd8723lkjhrn324' \ --header 'content-type: application/x-www-form-urlencoded' \ --data 'targeting[0][country][allow][0]=IS' \ --data 'targeting[0][country][allow][1]=IE' \ --data 'targeting[0][block_proxy]=1' \ -...-data 'targeting[0][os][allow][0][name]=Android' \ --data 'targeting[0][os][allow][0][comparison]=GTE' \ --data 'targeting[0][os][allow][0][version]=7.0.0' \ --data =
⚠️ Убедитесь, что вы соблюдаете все требования к типу данных массива, включая скобки и нумерацию.
Включить филиалы
Используйте этот метод, чтобы разрешить партнерам работать с предложением. Метод применим только в том случае, если уровень конфиденциальности предложения - Premoderation или Private.
Метод: POST /3.0/offer/enable-affiliate.
Запрос cURL для включения аффилиата #2:
curl --request POST \ --url https://api-rocketcompany.affise.com/3.0/offer/enable-affiliate \ --header 'api-key: 4sdf87fsdfd8723lkjhrn324' \ --header 'content-type: application/x-www-form-urlencoded' \ --data offer_id=1441594 \ --data pid=2
Отключить аффилиатов
Используйте этот метод, чтобы разрешить партнеру работать с предложением. Метод подходит для предложений с любым уровнем конфиденциальности.
Метод: POST /3.0/offer/enable-affiliate.
Запрос cURL для отключения аффилиата #2:
curl --request POST \ --url https://api-rocketcompany.affise.com/3.0/offer/disable-affiliate \ --header 'api-key: 4sdf87fsdfd8723lkjhrn324' \ --header 'content-type: application/x-www-form-urlencoded' \ --data offer_id=1441594 \ --data pid=2
Список отключенных/включенных филиалов
Используйте этот метод, чтобы получить список аффилиатов, которые могут или не могут работать с конкретным предложением.
Метод: GET /3.1/offers/{ID}/privacy.
Запрос:
https://api-rocketcompany.affise.com/3.1/offers/1441594/privacy?api-key=4sdf87fsdfd8723lkjhrn324
Обновление статуса офферов
Используйте этот метод для массового изменения статуса предложений.
Метод: POST /3.0/admin/offer/mass-update.
Запрос cURL для изменения статуса трех предложений на Paused:
curl --request POST \ --url https://api-rocketcompany.affise.com/3.0/admin/offer/mass-update \ --header 'api-: 4sdf87fsdfd8723lkjhrn324' \ --header 'content-type: application/x-www-form-urlencoded' \ --data 'offer_id[0]=1441594' \ --data 'offer_id[1]=1441528' \ --data 'offer_id[2]=1441527' \ --data status=suspended
Пожалуйста, свяжитесь со службой поддержки клиентов Affise по всем возникшим вопросам по электронной почте: [email protected].