Help Center
How
can we help?

Финансовый API

Подписаться

Финансовый оффер в нашей системе — это предложение от рекламодателя (например, банка), в котором комиссия вебмастера начисляется за оформление или выдачу кредитов, карт. Для работы с финансовыми офферами вебмастер может использовать специальный API, который позволяет настроить автоматическую отправку заявок к рекламодателям.

Заявка — минимальный набор персональных данных заемщика, необходимый для принятия решения банком/МФО о выдаче кредитных средств.

Заявка должна состоять из минимального и обязательного количества данных, по которым будет проходить первичная валидация нашей системой, перед отправкой рекламодателю.

Одна заявка может быть отправлена в разные банки/МФО, которые выбрал вебмастер. Если заявка соответствует параметрам какого-либо одного банка/МФО, она попадает в очередь на отправку в этот банк. Если заявка соответствует параметрам сразу нескольких банков, то она будет доставлена всем таким банкам.

Обратите внимание, что на данный момент финансовые офферы работают только с траффиком из России. Заявки с любой другой географией будут отклонены.

Сервис Firano

За работу с финансовыми офферами отвечает отдельный сервис — Firano. Именно на него вебмастер пересылает заполненные заявки от своих посетителей.

У Firano есть API, по которому происходит взаимодействие. Ознакомиться с принципами работы Firano API можно здесь.

Этот сервис проверяет данные, которые ему отправляют вебмастера, и передает заявки рекламодателям.

После получения заявки, банк рассматривает ее и сам контактирует с заявителем. Но за это Firano уже не отвечает.

Правила Firano

У каждого вебмастера в системе есть возможность настроить индивидуальные для его аккаунта правила Firano, по которым будет обрабатываться присланная заявка.

Каждое правило — это совокупность следующих настроек в Firano:

 

Настройка

Описание

1

Разрешенные офферы

Это те офферы, которые вебмастер лично выбрал для работы. Если банк/МФО не нравится вебмастеру, то его можно просто не выбирать. Тогда Firano никогда не отправит заявку в этот банк.

Выбирать вебмастер может среди всех предложенных офферов (банков/МФО), не зависимо от статуса аккаунта.

2

Задержка отправки заявок в банки/МФО

Вебмастер может настроить промежуток, с которым Firano будет рассылать заявки в банки/МФО.

Эта настройка позволяет проявить заботу о посетителях ресурса вебмастера. Ведь, если разослать заявку одновременно в 10 банков, то в течение 5 минут посетителю поступят 10 звонков из колл-центров и замучают вопросами о кредитах. Чтобы этого избежать, мы рекомендуем вам ставить отсрочку для рассылки заявок.

3

Максимально разрешенное количество банков/МФО

Вебмастер может искусственно ограничить количество банков/МФО, которые получат заявку посетителя.

Эта настройка позволяет проявить заботу о посетителях ресурса вебмастера. Если предположить, что заявка одного посетителя теоретически может попасть в 20 банков/МФО, и все они будут ему названивать, навязчиво предлагать услуги и впаривать карты, то вряд ли посетитель будет доволен. Поэтому мы рекомендуем использовать ограничение на количество офферов, которые могут получить заявку от одного посетителя.

Процесс обработки заявок

Заполненные заявки передаются Firano, с которыми сервис работает по определенной логике.

  1. Сначала заявка проходит первичную проверку в Firano. Сервис валидирует поля заявки, которые пришли в запросе. Если поля заполнены неверно или данных недостаточно, заявка не пройдет на следующий этап.
    Минимальные требования для заявки перечислены в разделе Запрос.
  2. Далее, Firano подбирает подходящие для этой заявки офферы.
    1. Во-первых, эти офферы должны быть одобрены вебмастером, который прислал запрос. Например, если вебмастер не хочет, чтобы его посетители имели дело с НекимБанком, то заявка в него не поступит.
    2. Во-вторых, данных, которые передал вебмастер, должно быть достаточно для заявки в конкретный банк. Бывает такое, что вебмастер выбрал НекийБанк в качестве оффера, с которым хотел бы работать, но посетитель не заполнил поле, которое требуется этому банку. В этом случае заявка до НекогоБанка не дойдет.
    3. Сервис прекратит рассылать заявки в тот момент, когда все офферы в списке закончатся, либо по достижении лимита (максимально разрешенное количество банков/МФО), который выставил вебмастер.

Работа с Firano по API

Чтобы взаимодействовать с Firano по API, достаточно настроить отправку запроса с необходимыми данными заявки.

Для тестирования запроса вы можете указать GET параметр sandbox:

  • sandbox = 1, тестовый режим. Тестовый режим позволяет отправить тестовые заявки и получить ответ от нашего сервера, при этом реальная отправка в банк/МФО не пройдет.
  • sandbox = 0, рабочий режим сервиса.

Аутентификация

Для аутентификации вебмастера Firano использует уникальный токен. Он генерируется автоматически, когда вы создаете новый инструмент, и использует ваш wm_id из системы. Этот токен надо обязательно передавать в запросе в параметре token.

Обратите внимание, токен Firano API не совпадает с токеном CItyAds API.

Получение id и ключа Firano API

Чтобы получить идетификационный номер и ключ, вам необходимо однажды создать инструмент Финансовый API:

  1. Зайдите в раздел Инструменты | Финансовый API.
  2. Войдите в режим редактирования нового инструмента, нажав на кнопку Создать.
  3. Выберите любые Поля или Офферы.
  4. Нажмите на кнопку Сохранить и получить код.
  5. В окне Код для вставки в переменной $queryParams:
    1. в параметре wm_id, будет персональный номер.
    2. в параметре token, будет ключ аутентификации.

Запрос

Данные, которые содержаться в заявке вебмастер передает по URL - https://finance.cityads.com/api/rest/v2/applications.json

Обязательные поля

Дополнительные необязательные поля, которые Firano может обработать, перечислены тут.

Firano, получив запрос с данными по заявке, осуществляет первичную проверку переданных значений.  Перед тем, как отправить эту заявку рекламодателям, чтобы заявка прошла первичную проверку на стороне Firano, верно должны быть переданы обязательные поля.

Параметр

Тип

Описание

Значение

surname

string

Фамилия

Только русские буквы, дефис и пробел

name

string

Имя

Только русские буквы, дефис и пробел

mobile

string

Мобильный телефон

Номер в формате: +7(xxx)xxx-xx-xx

Ответ

Ниже приведены коды ответов сервиса Firano.

Если Firano передает сообщения об ошибках и вам не удалось их устранить, используя инструкции, обратитесь в техническую поддержку.

Ответ

Расшифровка

{
    "application":{
     "id":4524772
     }
}

Заявка прошла успешно.

 

В случае успеха, после проверки данных, Firano вернет ответ, в котором будет содержаться номер заявки.

{
"error":{
    "code":401,
    "message":"Authorize Failed",
    "Errors":{
         "token":"Вебмастер не найден"
     }
     }
}

Неправильно введен token или wm_id.

Эта ошибка говорит о том, что вы передаете неверные аутентификационные данные. Исправьте свой ключ (token) или номер (wm_id).

Подробности в разделе Аутентификация.

{
"error":{
   "code":400,
   "message":"Validation Failed",
   "errors":{
       "surname":"Значение не должно быть пустым."
    }
    }
}

Ошибка в вводе данных.

Эта ошибка говорит о том, что в полях заявки содержатся неверные данные.

Проверьте значения согласно таблице Обязательные поля.

{
"error":{
   "code":409,
   "message":"Duplicate",
   "errors":{
    }
    }
}

Заявка уже поступала ранее.

 

Работа с Финансовым API

На платформе CityAds теперь можно начать работать с финансовыми офферами по API без каких-либо лишних настроек.

Именно для поддержки данной возможности в интерфейс вебмастера добавлен новый инструмент - Финансовый API. Он позволяет быстро и гибко настраивать параметры для работы с офферами по API, в том числе настраивать параметры отправки заявки в банки/МФО.

Интерфейс Финансового  API

Зайдя на страницу инструмента Финансовый API, вы увидите такой интерфейс:

На этой страничке вы можете:

  1. Узнать обобщенные цифры за выбранный период в Сводных показателях.
  2. Ознакомиться с текущей статистикой по тем офферам, с которыми вы сейчас работаете. Основные принципы работы со статистикой этого инструмента такие же, как и в общей Статистике.
  3. Просмотреть список офферов, по которым вы ранее создавали инструменты. С этой таблицей можно работать, как со всеми таблицами в интерфейсе.
    Обратите внимание, что этот список не означает, что вы работаете со всеми офферами из таблицы. То есть заявки, которые вы отсылаете Firano, не обязательно уходят на все эти офферы.
  4. Создать новое правило: как Firano будет обрабатывать ваши заявки.
  5. В Базе заявок перечислены все заявки, которые Firano отправил в банки/МФО.

Как создать / обновить правила

В Firano есть правила, по которым обрабатываются заявки от одного конкретного вебмастера. Эти правила вебмастер настраивает самостоятельно в интерфейсе. 

Чтобы обновить (или создать новые, если вы впервые заходите в интерфейс Финансового API) ваши личные правила Firano:

  1. В разделе Инструменты | Финансовый API нажмите на кнопку Создать.
  2. Выберите Географию, которой соответствует ваш траффик. После того, как вы добавите несколько регионов, в списке офферов (3) останутся те, которые принимают траффик из названых регионов.
  3. Настройка №1: Отметьте Офферы, с которыми хотите работать. Автоматически промаркеруются Поля, которые нужно передать для выбранных офферов.
    Только на те офферы, которые вы выберите, Firano будет отправлять заявки.
  4. Вы можете дополнительно выбрать Поля, если хотите передавать эти данные. Если выбирать Поля, то автоматически маркируются доступные Офферы с данным набором полей.
  5. Настройка №2: Выберите с какой отсрочкой нужно отправлять заявки в банки/МФО.
  6. Настройка №3: Ограничьте количество офферов, которые будут получать одну заявку.
  7. После того, как вы нажмете кнопку Сохранить и получить код:
    1. Заданные вами настройки передадутся в Firano и сохраняться там как постоянные для вашего аккаунта.
      Правила Firano, привязаны к вашему аккаунту. То есть если ранее вы уже создавали правило, то оно удалится, и в силу вступит последнее созданное вами.
    2. Офферы, которые вы выбирали, добавятся в таблицу на основной странице инструмента.
      Если случилось так, что вы сначала добавили оффер НекийБанк, а потом удалили его, то он все еще будет отображаться в таблице на основной странице. Чтобы удалить ненужные офферы из это таблице, обратитесь в тех-поддержку.

База заявок

На странице Инструменты | Финансовый API | База заявок вы можете просмотреть все свои заявки, которые Firano разослал в разные банки/МФО.

В таблице Все заявки, выводится следующая информация:

  1. ID заявки — это уникальный номер заявки, которая пришла в Firano от вебмастера.
  2. Оффер — название оффера, на который Firano отправил заявку.
  3. Статус заявки — это статус заявки от банка/МФО: отправлена, отклонена, принята, одобрена, ошибка.
  4. Субаккаунт — переданный от вебмастера параметр.
  5. Код ошибки — код ошибки от банка.
  6. Дата создания заявки — дата отправки заявки в банк.
Была ли эта статья полезной?
Пользователи, считающие этот материал полезным: 1 из 1
Еще есть вопросы? Отправить запрос

Комментарии

  • Avatar
    W109950

    В API нет параметров 'tariff' и 'credit_history', а в списке полей в личном кабинете такие поля есть. Это я заметил только два параметра сейчас. Неясно, что за тариф и кредитная история. Расшифровки нет.

  • Avatar
    SUPPORT Cityads

    Здравствуйте.
    Информацию добавим в описание в ближайшее время.
    tariff = Тип enum
    Значение
    S — Стандарт
    K — Клуб
    credit_history = Тип enum
    10 — Кредиты не брал
    20 — Погасил, были просрочки
    30 — Погасил, просрочек не было
    40 — Есть кредит, погашаю исправно
    50 — Есть кредит, были просрочки платежа
    60 — Есть текущая просроченная задолженность

  • Avatar
    W109950

    Где посмотреть списки значений всех параметров?
    Сейчас подключаю API. Ждём неделю.
    Конкретно интересуют параметры:
    "social_status",
    "work_status",
    "work_experience",
    "sub_id".

  • Avatar
    SUPPORT Cityads

    Описание всех статусов есть на странице инструмента по ссылке ниже
    https://finance.cityads.com/finance/#create
    http://pix.my/XWAp0RKd

  • Avatar
    W114546

    Уважаемый, на вашем скриншоте НЕТ возможных значений параметров, есть ТОЛЬКО НАЗВАНИЕ параметров. Пожалуйста скажите где можно узнать возможные значения work_status, ибо я без понятия что такое work_status : 10 и могу ли я передать work_status : 150 или work_status : "Работаю"

  • Avatar
    SUPPORT Cityads

    Значение статуса может быть разным, зависит от оффера. Уточните, по какому офферу вас интересует статус work_status

  • Avatar
    W48685

    решил попробовать данный инструмент, сделал все по инструкции, поставил на сайт, а в ответ вижу вот это:
    string(351) "HTTP/1.1 100 Continue HTTP/1.1 200 OK Server: nginx Content-Type: application/json Transfer-Encoding: chunked Connection: keep-alive Set-Cookie: PHPSESSID=sk46ufadqmk9i1ljk2cg53nt71; expires=Tue, 01-Aug-2017 19:31:26 GMT; path=/ Cache-Control: no-cache Date: Tue, 01 Aug 2017 18:31:26 GMT Allow: POST, GET {"application":{"id":13543423}}"
    В чем может быть проблема?

  • Avatar
    SUPPORT Cityads

    Здравствуйте.
    Пожалуйста, напишите ваш запрос в службу технической поддержки по ссылке ниже:
    https://help.cityads.com/hc/ru/requests/new

На базе технологии Zendesk