Firano¶
Инструмент и отдельный сервис, отвечающий за работу с офферами, по которым можно направлять заявки рекламодателям посредством API.
Данный сервис проверяет содержимое заявок, которые поступают от вебмастеров, и направляет их рекламодателям. У Firano есть API, по которому c ним можно взаимодействовать.
После получения заявки, рекламодатель рассматривает ее и сам контактирует с заявителем. В данном процессе Firano не участвует.
Заявка состоит из минимального набора персональных данных посетителя сайта вебмастера, необходимого для принятия рекламодателем решения о предоставлении заявителю той или иной услуги.
Заявка должна состоять из минимального и обязательного количества данных, по которым перед отправкой заявки рекламодателю будет происходить первичная валидация нашей системой.
См.также
Минимальные требования для заявки перечислены в разделе Запрос.
Одна заявка может быть отправлена разным рекламодателям, которых выбрал вебмастер. Если заявка соответствует параметрам хотя бы одного рекламодателя, она попадает в очередь на отправку данному рекламодателю. Если заявка соответствует параметрам сразу нескольких рекламодателей, она будет отправлена всем таким рекламодателям.
Процесс обработки заявок¶
Внимание
Обратите внимание, что на данный момент Firano работает только с трафиком из России. Заявки с любой другой географией будут отклонены.
Заполненные заявки передаются Firano, с которыми сервис работает по определенной логике.
Сначала заявка проходит первичную проверку в Firano. Сервис валидирует поля заявки, которые пришли в запросе. Если поля заполнены неверно или данных недостаточно, заявка не пройдет на следующий этап.
Далее Firano подбирает подходящие для данной заявки офферы.
Во-первых, данные офферы должны быть одобрены вебмастером, который прислал запрос.
Например, вебмастер может запретить направление заявок определенным рекламодателям.
Во-вторых, объема переданных Firano данных заявителя должно быть достаточно для направления заявки конкретному рекламодателю.
Например, вебмастер выбрал оффер определенного рекламодателя для направления заявок, но посетитель его сайта не заполнил обязательное поле, и заявка не была направлена данному рекламодателю.
Работа с Firano¶
Чтобы начать работать с Firano, вам необходимо настроить отправку запроса с необходимыми данными заявки.
Аутентификация¶
Внимание
Обратите внимание, токен Firano API не совпадает с токеном CityAds API.
Для аутентификации вебмастера Firano использует уникальный токен. Он генерируется автоматически и использует ваш wm_id
из системы. Данный токен надо обязательно передавать в запросе в параметре token
.
Получение id и токена Firano API
Чтобы получить идентификационный номер и ключ, вам необходимо зайти в Сгенерировать.
и нажать на кнопкуЗапрос¶
В системе есть возможность работать с Firano в тестовом режиме. Для тестирования запроса вы можете включить тестовый режим, нажав на переключатель sandbox, или указать GET-параметр sandbox
:
sandbox = 1
, тестовый режим. Тестовый режим позволяет отправить тестовые заявки и получить ответ от нашего сервера без реальной отправки заявок рекламодателям.sandbox = 0
, рабочий режим сервиса.
Данные, которые содержаться в заявке, вебмастер передает по URL https://firano.cityads.com/api/rest/v2/applications.json
Обязательные поля
См.также
Дополнительные (необязательные) поля, которые Firano может обрабатывать, перечислены здесь.
Firano, получив запрос с данными по заявке, осуществляет первичную проверку переданных значений. Перед тем, как отправить эту заявку рекламодателям, чтобы заявка прошла первичную проверку на стороне Firano, верно должны быть переданы обязательные поля.
Параметр | Тип | Описание | Значение |
---|---|---|---|
surname |
string |
Фамилия | Только русские буквы, дефис и пробел |
name |
string |
Имя | Только русские буквы, дефис и пробел |
mobile |
string |
Мобильный телефон | Номер в формате: +7(xxx)xxx-xx-xx |
is_agree_personal |
boolean |
Согласие на обработку данных |
Ответ¶
Ниже приведены коды ответов сервиса Firano. Если Firano передает сообщения об ошибках и вам не удалось их устранить, используя инструкции, обратитесь в техническую поддержку.
Ответ | Расшифровка |
---|---|
{
"application": {
"id": 4524772
}
}
|
Заявка прошла успешно. В случае успеха, после проверки данных, Firano вернет ответ, в котором будет содержаться номер заявки. |
{
"error": {
"code": 401,
"message": "Authorize Failed",
"errors": {
"token": "Вебмастер не найден"
}
}
}
|
Неправильно введен Эта ошибка говорит о том, что вы передаете неверные аутентификационные данные. Исправьте свой ключ ( Подробности в разделе Аутентификация. |
{
"error": {
"code": 400,
"message": "Validation Failed",
"errors": {
"surname": "Значение не должно быть пустым"
}
}
}
|
Ошибка в вводе данных. Эта ошибка говорит о том, что в полях заявки содержатся неверные данные. Проверьте значения согласно таблице Обязательные поля. |
Конструктор запросов¶
Для работы с Конструктором запросов вебмастеру необходимо придерживаться следующего алгоритма действий:
Откройте
.Выберете типы продуктов, по которым заявки посетителей сайта будут направляться рекламодателям.
Создайте персональный набор полей, которые будут направляться рекламодателям. При выборе вебмастером тех или иных полей Конструктор запросов будет показывать список офферов, для которых данный набор полей подходит.
Создайте персональный список офферов, в соответствии которым заявки посетителей сайта будут направляться рекламодателям.
Пример кода¶
Когда вы выберете типы продуктов, создадите набор полей и персональный список офферов, Firano сгенерирует для вас пример тела запроса в формате JSON и пример кода для самостоятельной настройки API на своем сайте.
- Для быстрого копирования примера тела запроса JSON вы можете нажать на кнопку Копировать JSON.
- Для быстрого копирования примера кода вы можете нажать на кнопку Копировать весь код.
База заявок¶
В разделе
отображаются все ваши заявки, направленные Firano различным рекламодателям. Здесь вы можете просматривать заявки «С группировкой по заявке» / «Без группировки».При просмотре заявок «С группировкой по заявке» выводится следующая информация:
- ID заявки — это уникальный номер заявки, которая пришла в Firano от вебмастера.
- Оффер — название оффера, на который Firano отправил заявку.
- Статус доставки — это статус доставки Firano заявки рекламодателям: доставлена во все офферы, доставлена не во все офферы.
- Субаккаунт — переданный от вебмастера параметр.
- Дата создания заявки — дата отправки заявки рекламодателю.
При просмотре заявок «Без группировки» выводится следующая информация:
- ID подзаявки — это уникальный номер заявки, которая пришла в Firano от вебмастера.
- Оффер — название оффера, на который Firano отправил заявку.
- Статус от банка — это статус заявки от рекламодателя: получена, отказ в выдаче кредита, дублирующая заявка, ошибка и др.
- Субаккаунт — переданный от вебмастера параметр.
- Дата создания заявки — дата отправки заявки рекламодателю.