Действия

Документация — различия между версиями

Материал из CPA Trafa Red

(IV. Пример ответа)
(IV. Пример ответа)
Строка 27: Строка 27:
 
)
 
)
 
</pre>
 
</pre>
 
+
----
 
'''Пример ответа об успешном выполнении запроса:'''
 
'''Пример ответа об успешном выполнении запроса:'''
  

Версия 19:57, 23 июня 2017

Отправка лидов
I. Установка на лендинге спец. кода
II. Пример использования спец. кода
Postback ссылка
Работа с API
I. Общая информация
II. Получение списка доступных Офферов
III. Получение информации о заказах
IV. Пример ответа
V. Отправка заказов Парковка доменов

IV. Пример ответа


Пример ответа об ошибке:

Array (
    [success] => FALSE
    [msg] => The filter_by field must be one of: date,date_range,ids,campaign.
)

Пример ответа с пустым результатом:

Array (
    [success] => TRUE
    [msg] => No results found
    [data] => Array (
        )
)

Пример ответа об успешном выполнении запроса:

V. Отправка заказов


URL = http://cpa.trafa.red/api/setOrder?uid=YYYY&key=XXXXXX
где uid и key можно найти у себя в профайле, после регистрации на cpa.trafa.red

На указаный адрес отправлять запросы методом POST. Все ответы будут в формате json.

Можно отправлять от 1 до 100 заказов за один раз. Если больше, - они просто не будут отрабатыватся.

Поля закаказа:

  • country - Страна в формате Alpha-2 ISO 3166-1 в нижнем регистре (*обязательное)
  • fio - ФИО (*)
  • phone - Номер телефона (*)
  • offer - Техническое название оффера. Например: brown_liquid. Список доступных офферов можно взять отсюда /Api/getOffers (*)
  • campaign - Название кампании, генерируется на стороне трафареда (*)
  • address - Адрес
  • price - Цена
  • count - Количество
  • offer_attribute - Свойство оффера "аттрибут"
  • offer_color - Свойство оффера "цвет"
  • offer_size - Свойство оффера "размер"
  • offer_type - Свойство оффера "тип"
  • offer_vendor - Свойство оффера "бренд"
  • utm_campaign - Метка utm_campaign
  • utm_content - Метка utm_content
  • utm_source - Метка utm_source
  • utm_medium - Метка utm_medium
  • utm_term - Метка utm_term
  • sub_id - Метка sub_id
  • landing_url - Полный URL страницы заказа
  • time - Время оформления заказа. Формат: Y-m-d H:i:s
  • ip - IP клиента

Масивы с даными заказа оберывается в глобальный масив orders.
Пример запроса на php :

$post = array(
	'orders' => array(
		array(
			'country'           => "ua",
			'fio'               => "FIO 1",
			'phone'             => "0941234567",
			'offer'             => "free_fuel_econom",
			'campaign'          => "6RZd82qsF",
			'utm_campaign'      => "",
			'utm_content'       => "",
			'utm_source'        => "",
			'utm_medium'        => "",
			'utm_term'          => "",
			'sub_id'            => "",
			'landing_url'       => "",
			'time'              => "",
			'ip'                => "",
			'offer_vendor'      => "",
			'offer_type'        => "",
			'offer_size'        => "",
			'offer_color'       => "",
			'offer_attribute'   => "",
			'count'             => "",
			'price'             => "",
			'address'           => "",
		),
		array(
			'country'           => "kg",
			'fio'               => "FIO 2",
			'phone'             => "0941234567",
			'offer'             => "free_fuel_econom",
			'campaign'          => "6RZd82qsF",
			'address'           => "",
			'price'             => "",
			'count'             => "",
			'offer_attribute'   => "",
			'offer_color'       => "",
			'offer_size'        => "",
			'offer_type'        => "",
			'offer_vendor'      => "",
			'utm_campaign'      => "",
			'utm_content'       => "",
			'utm_source'        => "",
			'utm_medium'        => "",
			'utm_term'          => "",
			'sub_id'            => "",
			'landing_url'       => "",
			'time'              => "",
			'ip'                => "",
		),
	)
);

$postFields = http_build_query($post);
$curl = curl_init();
curl_setopt_array($curl, array(
	CURLOPT_RETURNTRANSFER => 1,
	CURLOPT_URL => 'http://cpa.trafa.red/api/setOrder?uid=YYYY&key=XXXXXXX',
	CURLOPT_POST => 1,
	CURLOPT_POSTFIELDS => $postFields
));
$resp = curl_exec($curl);
curl_close($curl);


Варианты ответа
Если всё прошло гладко:
[{"success":true,"id":191776,"msg":1},{"success":true,"id":191777,"msg":1}]
Если есть ошибка:
[{"success":false,"id":false,"msg":"Wrong Offer name. Must be > 3 chars AND must exist"},{"success":false,"id":false,"msg":"Unknown country code"}
Идёт проверка по каждому обязательному полю.