Универсальный API Cpahub

Канал новостей и изменений в работе API: @uapi_cpahub
Обратная связь с разработчиками: @valieand

Универсальный API позволяет:

  • снизить затраты на разработку и поддержку програмного обеспечения
  • сократить время на подключение новых офферов
  • высвободить серверные ресурсы
  • повысить контроль прохождения заявок и оперативно реагировать на возникающие проблемы

Для этого, в API реализованы:

  • методы автоматизированной рассылки заявок по группам офферов в заданной очередности и с заданной временной задержкой
  • методы получения актуальной информации о статусе этих заявок
  • стандартизированные справочники, не привязанные к способу реализации АПИ рекламодателей
  • управление лимитами по входящим, исходящим и принятым рекламодателем заявкам
  • онлайн-инструменты, позволяющие быстро:
    • определять перечень параметров для любого оффера (или группы офферов) с указанием
      • обязательных
      • желательных, но не обязательных
      • неопределеных (если оффер не указан)
    • определять требования к значениям параметров (зависит от API рекламодателя), например:
      • ограничения по гео
      • ограничения по сумме кредита
      • ограничения по возрасту
    • тестировать запросы онлайн (API Call Builder), в частности:
      • конфигурировать запросы
      • получать примеры кода
      • выполнять запросы прямо со страницы
  • другие вспомогательные методы и интерфейсы

Запланировано (еще не реализовано):

  • Webhooks/Callbacks (автоматические запросы на сервер партнера при изменении статуса лида)
  • Обогащение данных (например, определение КЛАДР-кодов по произвольному адресу)
  • Гео-каталоги (КЛАДР, ФИАС, другое)
  • Редирект АПИ-траффика
  • Отчеты/мониторинг заявок в интерфейсе ЛК
  • Загрузка CSV-файла с заявками (интерфейс ЛК, e-mail)
  • Подписка на отчеты (email, Telegram)
  • Уведомления об ошибках (email, sms, Telegram)
  • Автоматизация валидации параметров заявки:
    • Проверка существования и доступности номера телефона
    • Проверка сущестования email-а
    • Поиск КЛАДР и ФИАС-кодов по произвольной записи адреса
  • Валидация заявки через кол-центры партнеров
  • Проверка кредитной истории
  • Блекджек, сауна, девчонки
  • ...предложите новую полезную идею разработчику и получите респект в карму

Основы API

Жизненный цикл заявки

Запрос на создание универсальной заявки

  • Авторизация партнера
  • Первичная валидация запроса на стороне Cpahub, независимо от оффера:
    • наличие общих обязательных параметров
    • соответствие значений параметров общим требованиям
  • Создание универсальной заявки, создание и постановка заявок по целевым офферам в очередь на отправку рекламодателям. В зависимости от доступности и пропускной способности серверов рекламодателей, отправка может занимать от нескольких секун до нескольких часов.
  • Ответ API

С этого момента можно получать данные об отправленных заявка. Дальнейшие шаги:

  • Вторичная валидация запроса на стороне Cpahub, по каждому офферу:
    • наличие обязательных параметров оффера
    • соответствие значений параметров требованиям оффера
    • отсутствие дублей по офферу (для запросов на создание)
    • соответствие выставленным лимитам по офферу по количеству заявок за промежуток времени
  • Отправка рекламодателям заявок из очереди
  • Валидация запросов на стороне рекламодателей, прием или отклонение заявок
  • Сохранение статуса завок, создание конверсии и дальнейшее предоставление информации по заявкам
  • Удаление универсальной заявки. Выполняется автоматически через 30 дней с момента создания.

Техническая спецификация

Универсальный API реализован на основе стандарта JSON API v1.0

Запрос к API

Формат запроса зависит от метода. В любом запросе обязательно наличие значений следующих параметров:

affilate_idID партнера в партнерской сети Cpahub
api_keyAPI KEY

Значения affiliate_id и api_key аутентифицируют партнера и предоставляют права на отправку универсальной заявки по группе офферов

Для получения API KEY или для добавления новых офферов в группу, обратитесь к аккаунт-менеджеру.

Ответ API

HTTP Status Codes

OK (200)

Запрос на получение данных успешно прошел авторизацию и валидацию на стороне Cpahub.

Created (201)

Запрос на создание успешно прошел авторизацию и валидацию на стороне Cpahub. Создана универсальная заявка. Заявки по целевым офферам помещены в очереди на отправку рекламодателям. Внимание: в момент создания универсальной заявки, статус заявок по целевым офферам неопределен.

Bad Request (400)

Ошибка в запросе. Более подробную информацию смотрите в response['errors']. RTFM.

Unauthorized (401)

Предоставленный в запросе API-ключ не соответствует affiliate_id. Перепроверьте api_key и affiliate_id. В случае необходимости, обратитесь за помощью к аккаунт-менеджеру.

Too Many Requests(429)

Превышен лимит запросов. Для всех партнеров установлен лимит 50 запросов в 10 секунд. Для задач, которые выолняются разово или редко, добавьте 1-секундную паузу между запросами. Например, в PHP это делается с помощью sleep(1);

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

Internal Server Error (500)

Что-то пошло не так. Администратор получил уведомление и уже разбирается. Повторите запрос через некоторое время.

Успешный ответ

{
  "data": [
    {
      "type": "type",
      "id": value,
      "attributes": { ... },
      "relationships" : { ... },
      "links": { ... }
    }
  ],
  "meta": {
    "request": { ... },
    "datetime": "2018-01-01 00:00:00",
    "count": 1000000
  }
}
dataДанные ответа на запрос. Массив объектов или объект.
data[0].typeТип данных: uleads - универсальная заявка, leads - заявка по целевому офферу
data[0].idID объекта
data[0].attributesАттрибуты объекта и их значения
data[0].relationshipsСвязанные объекты
data[0].linksСсылки на объект
metaМета-информация
meta.requestОригинальный запрос
meta.datetimeДата и время поступления запроса
meta.countКурсор паджинации

Ошибка

{
  "errors": [
    {
      "id": id,
      "title": "Error titile"
    },
    ...
  ],
  "meta": { ... }
}
errorМассив объектов - ошибок
error[0].idID ошибки
error[0].titleОписание ошибки

Создание заявки

MethodPOST /v1/uleads HTTP/1.1
URLhttps://uapi.cpahub.ru/v1/uleads
HeadersContent-Type: application/vnd.api+json
Accept: application/vnd.api+json
Body: JSON

Пример:

{
    "data": {
        "type": "uleads",
        "attributes": {
            "affiliate_id": 1,
            "api_key": "c31950bc9469926e7c533041a7b188e9",
            "affiliate_info1": "info1",
            "affiliate_info2": "info2",
            "affiliate_info3": "info3",
            "lead_datetime": "2018-01-01T00:00:00+03:00",
            "traffic_type_id": "context",
            "utm_source": "credit.cpahub.ru",
            "utm_medium": null,
            "utm_campaign": null,
            "utm_term": null,
            "utm_content": null,
            "is_test": true,
            "validation": null,
            "queueing": [
                {
                    "offers": [
                        503,
                        599
                    ],
                    "pause": 0
                },
                {
                    "offers": [
                        757,
                        727
                    ],
                    "pause": 300
                }
            ],
            "delivery": null,
            "personal_data": {
                "is_granted": true,
                "agent": "",
                "user": "",
                "grant_datetime": "2018-01-01T00:00:00+03:00"
            },
            "is_sms_confirmed": true,
            "second_name": "Тестов",
            "first_name": "Тест",
            "middle_name": "Тестович",
            "second_name_old": null,
            "first_name_old": null,
            "middle_name_old": null,
            "bdate": "1980-01-01",
            "cell_phone": "9169001020",
            "email": "mail@example.com",
            "web": "https://example.com",
            "snils": "1234567890",
            "inn": "1234567890",
            "ip": "127.0.0.1",
            "ref_full_name": "Доверенов",
            "ref_phone": "9160000000",
            "ref_relation_id": "friend",
            "children_num": 2,
            "work_time_last": 20,
            "work_time_profession": 200,
            "work_time_total": 2000,
            "gender_id": "male",
            "family_status_id": "married",
            "occupation_id": "student",
            "education_id": "higher_two_plus",
            "citizenship_id": "RU",
            "credit_history_id": "never",
            "addr_reg": {
                "text": "г. Москва, Ленинский пр-т, д.1 кв.1",
                "postal_code": "119049",
                "country": "Россия",
                "region_fias_id": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                "region_kladr_id": "7700000000000",
                "region_type": "г",
                "region": "Москва",
                "area_fias_id": null,
                "area_kladr_id": null,
                "area_type": null,
                "area": null,
                "city_fias_id": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                "city_kladr_id": "7700000000000",
                "city_type": "г",
                "city": "Москва",
                "city_area": "Центральный",
                "city_district_fias_id": null,
                "city_district_kladr_id": null,
                "city_district_type": null,
                "city_district": "Якиманка",
                "settlement_fias_id": null,
                "settlement_kladr_id": null,
                "settlement_type": null,
                "settlement": null,
                "street_fias_id": "5f2a1243-a57b-418e-baee-ff76f4993b45",
                "street_kladr_id": "77000000000168900",
                "street_type": "пр-кт",
                "street": "Ленинский",
                "house_kladr_id": null,
                "house_fias_id": null,
                "house_type": "д",
                "house": "1",
                "block_type": null,
                "block": null,
                "flat_type": "кв",
                "flat": "1",
                "is_owner": null,
                "date": null,
                "months": null,
                "phone": null
            },
            "addr_temp": null,
            "addr_fact": null,
            "addr_birth": null,
            "addr_work": null,
            "addr_get": null,
            "passport": {
                "text": null,
                "series": "1234",
                "num": "123456",
                "issuer": "Администрация президента",
                "issuer_code": "101",
                "date": "2001-01-01"
            },
            "passport_old": null,
            "car": {
                "make": "BMW",
                "model": "X5",
                "vin": null,
                "plate": null,
                "production_date": null,
                "purchase_date": null
            },
            "property": null,
            "0": {
                "has_cottage": true,
                "has_townhouse": true,
                "has_flat": null,
                "has_appartments": null,
                "has_share": null,
                "has_room": null,
                "has_summer_cottage": null,
                "has_capital_cottage": null,
                "has_stead": null,
                "has_garage": null
            },
            "work": {
                "org_title": null,
                "inn": null,
                "manager_full_name": null,
                "org_type_id": null,
                "is_state_owned": null,
                "is_commercial": null,
                "has_foreign_capital": null,
                "industry_id": null
            },
            "income": {
                "work": null,
                "business": null,
                "pension": null,
                "rent": null,
                "other": null
            },
            "credit": {
                "amount": 60000,
                "period": 24,
                "payment": null,
                "max_payment": null,
                "currency_id": "RUB"
            },
            "card": {
                "name": null,
                "type_id": null,
                "currency_id": null,
                "limit": null,
                "max_payment": null,
                "has_grace": null,
                "has_cashback": null,
                "payment_system_id": null
            }
        }
    }
}
Атрибуты и значения

Система автоматически определяет аттрибуты и требования к значениям аттрибутов для выбранной группы офферов. Требования офферов к значениям атрибутов объединяются логическим &, т.е. удовлетворяются требования всех офферов. Примечания по конкретному офферу отмечены беджем offer_id

Укажите оффер(а):

 
Обяз Параметр Тип Название Примечания
Affiliate data
affiliate_id integer Affiliate ID ID партнера в сети Cpahub
api_key string API KEY API-ключ партнера
maxLength: 32, minLength: 32
affiliate_info1 string|null Affiliate Info1 Данные партнера
maxLength: 50
affiliate_info2 string|null Affiliate Info2 Данные партнера
maxLength: 50
affiliate_info3 string|null Affiliate Info3 Данные партнера
maxLength: 50
Marketing data
lead_datetime string|null Lead Datetime RFC3339 Пример: 2019-01-01T00:00:00+03:00
traffic_type_id enum Traffic Type ID Значение из справочника (html | json)
utm_source string|null UTM Source
maxLength: 255
utm_medium string|null UTM Medium
maxLength: 255
utm_campaign string|null UTM Campaign
maxLength: 255
utm_term string|null UTM Term
maxLength: 255
utm_content string|null UTM Content
maxLength: 255
Processing instructions
is_test boolean|null Is Test
validation object|null Validation instructions
queueing array Queueing instructions Пример:
[{"offers": [123,345]}, {"offers": [567,789], "pause":3600}, {"offers": [734], "pause":1800}]
В этом примере, по офферам 123 и 345 заявки будут отправлены сразу же, без паузы. Если рекламодатели приняли хотя бы одну заявку, через 3600 секунд будет отправлена заявка на оффера 567 и 789. Если рекламодатели не приняли ни одну заявку в первой группе, заявки на вторую группу офферов отправятся без паузы. Далее аналогично.
minItems: 1
queueing[].offers array Offers Перечень офферов
minItems: 1
queueing[].offers[] integer Offer ID Offer ID из списка API-офферов
queueing[].pause integer|null Pause Пауза в секундах перед отправкой заявки по офферам группы
maximum: 86400
delivery object|null Delivery instructions
Personal data and other permissions
personal_data.is_granted boolean Personal Data Is Granted
personal_data.agent string|null Personal Data Agent
maxLength: 50
personal_data.user string|null Personal Data User
maxLength: 50
personal_data.grant_datetime string|null Personal Data Grant Datetime RFC3339 Пример: 2019-01-01T00:00:00+03:00
is_sms_confirmed boolean|null Is SMS confirmed
credit_history_grant_datetime string|null Credit History Grant Datetime RFC3339 Пример: 2019-01-01T00:00:00+03:00
User data
second_name string|null Second Name
maxLength: 50, minLength: 2, pattern: ^[\p{Cyrillic}\s\-]+$
first_name string|null First Name
maxLength: 50, minLength: 2, pattern: ^[\p{Cyrillic}\s\-]+$
middle_name string|null Middle Name
maxLength: 50, minLength: 2, pattern: ^[\p{Cyrillic}\s\-]+$
second_name_old string|null Second Name Old
maxLength: 50, minLength: 2, pattern: ^[\p{Cyrillic}\s\-]+$
first_name_old string|null First Name Old
maxLength: 50, minLength: 2, pattern: ^[\p{Cyrillic}\s\-]+$
middle_name_old string|null Middle Name Old
maxLength: 50, minLength: 2, pattern: ^[\p{Cyrillic}\s\-]+$
bdate string|null Birth date RFC3339 Пример: 2019-01-01
cell_phone string|null Cell Phone
pattern: ^\d{10}$
email string|null Email
maxLength: 50, pattern: ^\S+@\S+$
web string|null Web
maxLength: 255, pattern: (https?:\/\/(?:www\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\.[^\s]{2,}|www\.[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\.[^\s]{2,}|https?:\/\/(?:www\.|(?!www))[a-zA-Z0-9]+\.[^\s]{2,}|www\.[a-zA-Z0-9]+\.[^\s]{2,})
snils string|null SNILS
maxLength: 12
inn string|null INN
maxLength: 12
ip string|null IPv4 address
maxLength: 15, pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
ref_full_name string|null Ref Full Name
maxLength: 150, pattern: ^[\p{Cyrillic}\s\-]+$
ref_phone string|null Ref Phone
pattern: ^\d{10}$
ref_relation_id enum Ref Relation Значение из справочника (html | json)
children_num integer|null Children Num
work_time_last integer|null Work Time Last
work_time_profession integer|null Work Time Profession
work_time_total integer|null Work Time Total
gender_id enum Gender ID Значение из справочника (html | json)
family_status_id enum Family Status ID Значение из справочника (html | json)
occupation_id enum Occupation ID Значение из справочника (html | json)
education_id enum Education ID Значение из справочника (html | json)
citizenship_id enum Citizenship ID ISO_3166-1:
Значение из справочника (html | json)
credit_history_id enum Credit History ID Значение из справочника (html | json)
Registration Address
addr_reg.text string|null Полный адрес
maxLength: 500
addr_reg.postal_code string|null Индекс
maxLength: 6
addr_reg.country string|null Страна
maxLength: 60
addr_reg.region_fias_id string|null Код ФИАС региона
maxLength: 36
addr_reg.region_kladr_id string|null Код КЛАДР региона
maxLength: 13
addr_reg.region_type string|null Тип региона
maxLength: 20
addr_reg.region string|null Регион
maxLength: 60
addr_reg.area_fias_id string|null Код ФИАС района в регионе
maxLength: 36
addr_reg.area_kladr_id string|null Код КЛАДР района в регионе
maxLength: 13
addr_reg.area_type string|null Тип района в регионе
maxLength: 20
addr_reg.area string|null Район в регионе
maxLength: 60
addr_reg.city_fias_id string|null Код ФИАС города
maxLength: 36
addr_reg.city_kladr_id string|null Код КЛАДР города
maxLength: 13
addr_reg.city_type string|null Тип города
maxLength: 20
addr_reg.city string|null Город
maxLength: 60
addr_reg.city_area string|null Город
maxLength: 36
addr_reg.city_district_fias_id string|null Код ФИАС района города
maxLength: 36
addr_reg.city_district_kladr_id string|null Код КЛАДР района города
maxLength: 13
addr_reg.city_district_type string|null Тип района города
maxLength: 20
addr_reg.city_district string|null Район города
maxLength: 60
addr_reg.settlement_fias_id string|null Код ФИАС нас. пункта
maxLength: 36
addr_reg.settlement_kladr_id string|null Код КЛАДР нас. пункта
maxLength: 13
addr_reg.settlement_type string|null Тип населенного пункта
maxLength: 20
addr_reg.settlement string|null Населенный пункт
maxLength: 60
addr_reg.street_fias_id string|null Код ФИАС улицы
maxLength: 36
addr_reg.street_kladr_id string|null Код КЛАДР улицы
maxLength: 17
addr_reg.street_type string|null Тип улицы
maxLength: 20
addr_reg.street string|null Улица
maxLength: 60
addr_reg.house_fias_id string|null Код ФИАС дома
maxLength: 36
addr_reg.house_kladr_id string|null Код КЛАДР дома
maxLength: 20
addr_reg.house_type string|null Тип дома
maxLength: 20
addr_reg.house string|null Дом
maxLength: 32
addr_reg.block_type string|null Тип корпуса/строения
maxLength: 20
addr_reg.block string|null Корпус/строение
maxLength: 32
addr_reg.flat_type string|null Тип квартиры
maxLength: 20
addr_reg.flat string|null Квартира
maxLength: 32
addr_reg.is_owner boolean|null В собственности
addr_reg.date string|null Start date RFC3339 Пример: 2019-01-01
addr_reg.months integer|null Время проживания, мес
addr_reg.phone string|null Телефон
pattern: ^\d{10}$
Temporary Registration Address
addr_temp.text string|null Полный адрес
maxLength: 500
addr_temp.postal_code string|null Индекс
maxLength: 6
addr_temp.country string|null Страна
maxLength: 60
addr_temp.region_fias_id string|null Код ФИАС региона
maxLength: 36
addr_temp.region_kladr_id string|null Код КЛАДР региона
maxLength: 13
addr_temp.region_type string|null Тип региона
maxLength: 20
addr_temp.region string|null Регион
maxLength: 60
addr_temp.area_fias_id string|null Код ФИАС района в регионе
maxLength: 36
addr_temp.area_kladr_id string|null Код КЛАДР района в регионе
maxLength: 13
addr_temp.area_type string|null Тип района в регионе
maxLength: 20
addr_temp.area string|null Район в регионе
maxLength: 60
addr_temp.city_fias_id string|null Код ФИАС города
maxLength: 36
addr_temp.city_kladr_id string|null Код КЛАДР города
maxLength: 13
addr_temp.city_type string|null Тип города
maxLength: 20
addr_temp.city string|null Город
maxLength: 60
addr_temp.city_area string|null Город
maxLength: 36
addr_temp.city_district_fias_id string|null Код ФИАС района города
maxLength: 36
addr_temp.city_district_kladr_id string|null Код КЛАДР района города
maxLength: 13
addr_temp.city_district_type string|null Тип района города
maxLength: 20
addr_temp.city_district string|null Район города
maxLength: 60
addr_temp.settlement_fias_id string|null Код ФИАС нас. пункта
maxLength: 36
addr_temp.settlement_kladr_id string|null Код КЛАДР нас. пункта
maxLength: 13
addr_temp.settlement_type string|null Тип населенного пункта
maxLength: 20
addr_temp.settlement string|null Населенный пункт
maxLength: 60
addr_temp.street_fias_id string|null Код ФИАС улицы
maxLength: 36
addr_temp.street_kladr_id string|null Код КЛАДР улицы
maxLength: 17
addr_temp.street_type string|null Тип улицы
maxLength: 20
addr_temp.street string|null Улица
maxLength: 60
addr_temp.house_fias_id string|null Код ФИАС дома
maxLength: 36
addr_temp.house_kladr_id string|null Код КЛАДР дома
maxLength: 20
addr_temp.house_type string|null Тип дома
maxLength: 20
addr_temp.house string|null Дом
maxLength: 32
addr_temp.block_type string|null Тип корпуса/строения
maxLength: 20
addr_temp.block string|null Корпус/строение
maxLength: 32
addr_temp.flat_type string|null Тип квартиры
maxLength: 20
addr_temp.flat string|null Квартира
maxLength: 32
addr_temp.is_owner boolean|null В собственности
addr_temp.date string|null Start date RFC3339 Пример: 2019-01-01
addr_temp.months integer|null Время проживания, мес
addr_temp.phone string|null Телефон
pattern: ^\d{10}$
Factual Address
addr_fact.text string|null Полный адрес
maxLength: 500
addr_fact.postal_code string|null Индекс
maxLength: 6
addr_fact.country string|null Страна
maxLength: 60
addr_fact.region_fias_id string|null Код ФИАС региона
maxLength: 36
addr_fact.region_kladr_id string|null Код КЛАДР региона
maxLength: 13
addr_fact.region_type string|null Тип региона
maxLength: 20
addr_fact.region string|null Регион
maxLength: 60
addr_fact.area_fias_id string|null Код ФИАС района в регионе
maxLength: 36
addr_fact.area_kladr_id string|null Код КЛАДР района в регионе
maxLength: 13
addr_fact.area_type string|null Тип района в регионе
maxLength: 20
addr_fact.area string|null Район в регионе
maxLength: 60
addr_fact.city_fias_id string|null Код ФИАС города
maxLength: 36
addr_fact.city_kladr_id string|null Код КЛАДР города
maxLength: 13
addr_fact.city_type string|null Тип города
maxLength: 20
addr_fact.city string|null Город
maxLength: 60
addr_fact.city_area string|null Город
maxLength: 36
addr_fact.city_district_fias_id string|null Код ФИАС района города
maxLength: 36
addr_fact.city_district_kladr_id string|null Код КЛАДР района города
maxLength: 13
addr_fact.city_district_type string|null Тип района города
maxLength: 20
addr_fact.city_district string|null Район города
maxLength: 60
addr_fact.settlement_fias_id string|null Код ФИАС нас. пункта
maxLength: 36
addr_fact.settlement_kladr_id string|null Код КЛАДР нас. пункта
maxLength: 13
addr_fact.settlement_type string|null Тип населенного пункта
maxLength: 20
addr_fact.settlement string|null Населенный пункт
maxLength: 60
addr_fact.street_fias_id string|null Код ФИАС улицы
maxLength: 36
addr_fact.street_kladr_id string|null Код КЛАДР улицы
maxLength: 17
addr_fact.street_type string|null Тип улицы
maxLength: 20
addr_fact.street string|null Улица
maxLength: 60
addr_fact.house_fias_id string|null Код ФИАС дома
maxLength: 36
addr_fact.house_kladr_id string|null Код КЛАДР дома
maxLength: 20
addr_fact.house_type string|null Тип дома
maxLength: 20
addr_fact.house string|null Дом
maxLength: 32
addr_fact.block_type string|null Тип корпуса/строения
maxLength: 20
addr_fact.block string|null Корпус/строение
maxLength: 32
addr_fact.flat_type string|null Тип квартиры
maxLength: 20
addr_fact.flat string|null Квартира
maxLength: 32
addr_fact.is_owner boolean|null В собственности
addr_fact.date string|null Start date RFC3339 Пример: 2019-01-01
addr_fact.months integer|null Время проживания, мес
addr_fact.phone string|null Телефон
pattern: ^\d{10}$
Birth Place Address
addr_birth.text string|null Полный адрес
maxLength: 500
addr_birth.postal_code string|null Индекс
maxLength: 6
addr_birth.country string|null Страна
maxLength: 60
addr_birth.region_fias_id string|null Код ФИАС региона
maxLength: 36
addr_birth.region_kladr_id string|null Код КЛАДР региона
maxLength: 13
addr_birth.region_type string|null Тип региона
maxLength: 20
addr_birth.region string|null Регион
maxLength: 60
addr_birth.area_fias_id string|null Код ФИАС района в регионе
maxLength: 36
addr_birth.area_kladr_id string|null Код КЛАДР района в регионе
maxLength: 13
addr_birth.area_type string|null Тип района в регионе
maxLength: 20
addr_birth.area string|null Район в регионе
maxLength: 60
addr_birth.city_fias_id string|null Код ФИАС города
maxLength: 36
addr_birth.city_kladr_id string|null Код КЛАДР города
maxLength: 13
addr_birth.city_type string|null Тип города
maxLength: 20
addr_birth.city string|null Город
maxLength: 60
addr_birth.city_area string|null Город
maxLength: 36
addr_birth.city_district_fias_id string|null Код ФИАС района города
maxLength: 36
addr_birth.city_district_kladr_id string|null Код КЛАДР района города
maxLength: 13
addr_birth.city_district_type string|null Тип района города
maxLength: 20
addr_birth.city_district string|null Район города
maxLength: 60
addr_birth.settlement_fias_id string|null Код ФИАС нас. пункта
maxLength: 36
addr_birth.settlement_kladr_id string|null Код КЛАДР нас. пункта
maxLength: 13
addr_birth.settlement_type string|null Тип населенного пункта
maxLength: 20
addr_birth.settlement string|null Населенный пункт
maxLength: 60
addr_birth.street_fias_id string|null Код ФИАС улицы
maxLength: 36
addr_birth.street_kladr_id string|null Код КЛАДР улицы
maxLength: 17
addr_birth.street_type string|null Тип улицы
maxLength: 20
addr_birth.street string|null Улица
maxLength: 60
addr_birth.house_fias_id string|null Код ФИАС дома
maxLength: 36
addr_birth.house_kladr_id string|null Код КЛАДР дома
maxLength: 20
addr_birth.house_type string|null Тип дома
maxLength: 20
addr_birth.house string|null Дом
maxLength: 32
addr_birth.block_type string|null Тип корпуса/строения
maxLength: 20
addr_birth.block string|null Корпус/строение
maxLength: 32
addr_birth.flat_type string|null Тип квартиры
maxLength: 20
addr_birth.flat string|null Квартира
maxLength: 32
addr_birth.is_owner boolean|null В собственности
addr_birth.date string|null Start date RFC3339 Пример: 2019-01-01
addr_birth.months integer|null Время проживания, мес
addr_birth.phone string|null Телефон
pattern: ^\d{10}$
Work Address
addr_work.text string|null Полный адрес
maxLength: 500
addr_work.postal_code string|null Индекс
maxLength: 6
addr_work.country string|null Страна
maxLength: 60
addr_work.region_fias_id string|null Код ФИАС региона
maxLength: 36
addr_work.region_kladr_id string|null Код КЛАДР региона
maxLength: 13
addr_work.region_type string|null Тип региона
maxLength: 20
addr_work.region string|null Регион
maxLength: 60
addr_work.area_fias_id string|null Код ФИАС района в регионе
maxLength: 36
addr_work.area_kladr_id string|null Код КЛАДР района в регионе
maxLength: 13
addr_work.area_type string|null Тип района в регионе
maxLength: 20
addr_work.area string|null Район в регионе
maxLength: 60
addr_work.city_fias_id string|null Код ФИАС города
maxLength: 36
addr_work.city_kladr_id string|null Код КЛАДР города
maxLength: 13
addr_work.city_type string|null Тип города
maxLength: 20
addr_work.city string|null Город
maxLength: 60
addr_work.city_area string|null Город
maxLength: 36
addr_work.city_district_fias_id string|null Код ФИАС района города
maxLength: 36
addr_work.city_district_kladr_id string|null Код КЛАДР района города
maxLength: 13
addr_work.city_district_type string|null Тип района города
maxLength: 20
addr_work.city_district string|null Район города
maxLength: 60
addr_work.settlement_fias_id string|null Код ФИАС нас. пункта
maxLength: 36
addr_work.settlement_kladr_id string|null Код КЛАДР нас. пункта
maxLength: 13
addr_work.settlement_type string|null Тип населенного пункта
maxLength: 20
addr_work.settlement string|null Населенный пункт
maxLength: 60
addr_work.street_fias_id string|null Код ФИАС улицы
maxLength: 36
addr_work.street_kladr_id string|null Код КЛАДР улицы
maxLength: 17
addr_work.street_type string|null Тип улицы
maxLength: 20
addr_work.street string|null Улица
maxLength: 60
addr_work.house_fias_id string|null Код ФИАС дома
maxLength: 36
addr_work.house_kladr_id string|null Код КЛАДР дома
maxLength: 20
addr_work.house_type string|null Тип дома
maxLength: 20
addr_work.house string|null Дом
maxLength: 32
addr_work.block_type string|null Тип корпуса/строения
maxLength: 20
addr_work.block string|null Корпус/строение
maxLength: 32
addr_work.flat_type string|null Тип квартиры
maxLength: 20
addr_work.flat string|null Квартира
maxLength: 32
addr_work.is_owner boolean|null В собственности
addr_work.date string|null Start date RFC3339 Пример: 2019-01-01
addr_work.months integer|null Время проживания, мес
addr_work.phone string|null Телефон
pattern: ^\d{10}$
Get Service Address
addr_get.text string|null Полный адрес
maxLength: 500
addr_get.postal_code string|null Индекс
maxLength: 6
addr_get.country string|null Страна
maxLength: 60
addr_get.region_fias_id string|null Код ФИАС региона
maxLength: 36
addr_get.region_kladr_id string|null Код КЛАДР региона
maxLength: 13
addr_get.region_type string|null Тип региона
maxLength: 20
addr_get.region string|null Регион
maxLength: 60
addr_get.area_fias_id string|null Код ФИАС района в регионе
maxLength: 36
addr_get.area_kladr_id string|null Код КЛАДР района в регионе
maxLength: 13
addr_get.area_type string|null Тип района в регионе
maxLength: 20
addr_get.area string|null Район в регионе
maxLength: 60
addr_get.city_fias_id string|null Код ФИАС города
maxLength: 36
addr_get.city_kladr_id string|null Код КЛАДР города
maxLength: 13
addr_get.city_type string|null Тип города
maxLength: 20
addr_get.city string|null Город
maxLength: 60
addr_get.city_area string|null Город
maxLength: 36
addr_get.city_district_fias_id string|null Код ФИАС района города
maxLength: 36
addr_get.city_district_kladr_id string|null Код КЛАДР района города
maxLength: 13
addr_get.city_district_type string|null Тип района города
maxLength: 20
addr_get.city_district string|null Район города
maxLength: 60
addr_get.settlement_fias_id string|null Код ФИАС нас. пункта
maxLength: 36
addr_get.settlement_kladr_id string|null Код КЛАДР нас. пункта
maxLength: 13
addr_get.settlement_type string|null Тип населенного пункта
maxLength: 20
addr_get.settlement string|null Населенный пункт
maxLength: 60
addr_get.street_fias_id string|null Код ФИАС улицы
maxLength: 36
addr_get.street_kladr_id string|null Код КЛАДР улицы
maxLength: 17
addr_get.street_type string|null Тип улицы
maxLength: 20
addr_get.street string|null Улица
maxLength: 60
addr_get.house_fias_id string|null Код ФИАС дома
maxLength: 36
addr_get.house_kladr_id string|null Код КЛАДР дома
maxLength: 20
addr_get.house_type string|null Тип дома
maxLength: 20
addr_get.house string|null Дом
maxLength: 32
addr_get.block_type string|null Тип корпуса/строения
maxLength: 20
addr_get.block string|null Корпус/строение
maxLength: 32
addr_get.flat_type string|null Тип квартиры
maxLength: 20
addr_get.flat string|null Квартира
maxLength: 32
addr_get.is_owner boolean|null В собственности
addr_get.date string|null Start date RFC3339 Пример: 2019-01-01
addr_get.months integer|null Время проживания, мес
addr_get.phone string|null Телефон
pattern: ^\d{10}$
Passport
passport.text string|null Text
maxLength: 500
passport.series string|null Series
maxLength: 4, minLength: 4
passport.num string|null Number
maxLength: 6, minLength: 6
passport.issuer string|null Issuer
maxLength: 255
passport.issuer_code string|null Issuer code
maxLength: 20
passport.date string|null Date RFC3339 Пример: 2019-01-01
Passport Old
passport_old.text string|null Text
maxLength: 500
passport_old.series string|null Series
maxLength: 4, minLength: 4
passport_old.num string|null Number
maxLength: 6, minLength: 6
passport_old.issuer string|null Issuer
maxLength: 255
passport_old.issuer_code string|null Issuer code
maxLength: 20
passport_old.date string|null Date RFC3339 Пример: 2019-01-01
Car
car.make string|null Make
maxLength: 32
car.model string|null Model
maxLength: 32
car.vin string|null VIN
maxLength: 17
car.plate string|null Plate number
maxLength: 32
car.production_date string|null Production date RFC3339 Пример: 2019-01-01
car.purchase_date string|null Purchase date RFC3339 Пример: 2019-01-01
Property
property.has_cottage boolean|null Коттедж
property.has_townhouse boolean|null Таунхауз
property.has_flat boolean|null Квартира
property.has_appartments boolean|null Апартаменты
property.has_share boolean|null Долевая собственность
property.has_room boolean|null Комната
property.has_summer_cottage boolean|null Летняя дача
property.has_capital_cottage boolean|null Капитальная дача
property.has_stead boolean|null Земельный участок
property.has_garage boolean|null Гараж
Work
work.org_title string|null Место работы
maxLength: 255
work.inn string|null INN
maxLength: 12
work.title string|null Должность
maxLength: 255
work.manager_full_name string|null ФИО Руководителя
maxLength: 150
work.org_type_id enum Организационно-правовая форма Значение из справочника (html | json)
work.is_state_owned boolean|null Государственное?
work.is_commercial boolean|null Коммерческое?
work.has_foreign_capital boolean|null Участие иностранного капитала?
work.industry_id enum Отрасль ОКВЭД-2:
Значение из справочника (html | json)
Income
income.work integer|null Зарплата с учетом премий
income.business integer|null Доход от собственного бизнеса
income.pension integer|null Пенсия или регулярные выплаты
income.rent integer|null Доход от сдачи имущества в аренду
income.other integer|null Прочие ежемесячные доходы
Credit
credit.amount integer|null Amount
credit.period integer|null Period в месяцах
credit.payment integer|null Payment
credit.max_payment integer|null Max payment
credit.currency_id enum Currency ISO 4217:
Значение из справочника (html | json)
Card
card.name string|null Название карты
maxLength: 50
card.type_id enum Тип карты Значение из справочника (html | json)
card.currency_id enum Валюта ISO 4217:
Значение из справочника (html | json)
card.limit integer|null Желаемая сумма лимита
card.max_payment integer|null Максимальный ежемесячный платеж
card.has_grace boolean|null Наличие грейс периода
card.has_cashback boolean|null Наличие кэшбек
card.payment_system_id enum Платежная система Значение из справочника (html | json)
Ответ API на запрос о создании универсальной заявки

Пример:

{
    "data": {
        "type": "uleads",
        "id": 15,
        "attributes": {
            "status": "accepted",
            "created_at": "2019-03-20T22:50:43+00:00"
        },
        "links": {
            "self": "http://uapi.cpahub.ru/v1/uleads/15"
        },
        "relationships": {
            "leads": {
                "data": [
                    {
                        "id": 36,
                        "type": "leads"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "leads",
            "id": 36,
            "attributes": {
                "offer_id": 727,
                "status": "queued",
                "created_at": "2019-03-20T22:50:43+00:00",
                "before_adv_errors": null
            },
            "links": {
                "self": "http://uapi.cpahub.ru/v1/uleads/15/leads/36"
            }
        }
    ],
    "meta": {
        "request": {
            ...
        },
        "httpCode": 201
    }
}
HTTP Status Code:201
data.attributes.statusСтатус заявки:
queuedНе обработана
acceptedПринята Cpahub
rejectedОтклонена Cpahub
data.idID универсальной заявки
data.attributes.created_atДата и время создания универсальной заявки
data.includedЛиды, созданные по данной универсальной заявке
data.included[].idID лида
data.included[].attributes.offer_idID оффера
data.included[].attributes.statusСтатус лида
queuedНе обработана
acceptedПринята рекламодателем
rejectedОтклонена
data.included[].attributes.created_atДата и время создания лида
data.included[].attributes.before_adv_errorsОшибки, обнаруженные перед отправкой лида. Конверсии по таким лидам не создаются.

Описание других полей см выше

Получение данных

По одной универсальной заявке

MethodGET /v1/uleads/<id> HTTP/1.1
HeadersAccept: application/vnd.api+json
URLhttps://uapi.cpahub.ru/v1/uleads

Пример:
https://uapi.cpahub.ru/v1/uleads/15?affiliate_id=1&api_key=c31950bc9469926e7c533041a7b188e9

Параметры
affiliate_idID партнера в сети Cpahub
api_keyAPI KEY партнера
idID заявки в системе API
Ответ API

Пример:

{
    "data": {
        "type": "uleads",
        "id": 15,
        "attributes": {
            "status": "accepted",
            "created_at": "2019-03-20T22:50:43+00:00"
        },
        "links": {
            "self": "http://uapi.cpahub.ru/v1/uleads/15"
        },
        "relationships": {
            "leads": {
                "data": [
                    {
                        "id": 36,
                        "type": "leads"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "leads",
            "id": 36,
            "attributes": {
                "offer_id": 727,
                "status": "accepted",
                "created_at": "2019-03-20T22:50:43+00:00",
                "before_adv_errors": null
                "errors": null,
                "conversion_id": 123456789,
            },
            "links": {
                "self": "http://uapi.cpahub.ru/v1/uleads/15/leads/36"
            }
        }
    ]
}
HTTP Status Code:200
data.attributes.statusСтатус заявки:
queuedНе обработана
acceptedПринята Cpahub
rejectedОтклонена Cpahub
data.idID универсальной заявки
data.attributes.created_atДата и время создания универсальной заявки
data.includedЛиды, созданные по данной универсальной заявке
data.included[].idID лида
data.included[].attributes.offer_idID оффера
data.included[].attributes.statusСтатус лида
queuedНе обработана
acceptedПринята рекламодателем
rejectedОтклонена
data.included[].attributes.created_atДата и время создания лида
data.included[].attributes.before_adv_errorsОшибки, обнаруженные перед отправкой лида. Конверсии по таким лидам не создаются.
data.included[].attributes.errorsОшибки, обнаруженные рекламодетелем
data.included[].attributes.conversion_idID конверсии, если была создана

Описание других полей см выше

По массиву универсальных заявок

В разработке...

По одному лиду

MethodGET /v1/leads/<id> HTTP/1.1
HeadersAccept: application/vnd.api+json
URLhttps://uapi.cpahub.ru/v1/leads

Пример:
https://uapi.cpahub.ru/v1/leads/123?affiliate_id=1&api_key=c31950bc9469926e7c533041a7b188e9

Параметры
affiliate_idID партнера в сети Cpahub
api_keyAPI KEY партнера
idID лида в системе API
Ответ API

Пример:

{
  "data": {
    "type": "leads",
    "id": 1031950,
    "attributes": {
      "ulead_id": 355502,
      "offer_id": 727,
      "status": "accepted",
      "created_at": "2019-04-26T17:49:07+03:00",
      "before_adv_errors": null,
      "errors": null,
      "conversion_id": null
    },
    "links": {
      "self": "https://uapi.cpahub.ru/v1/leads/1031950"
    },
    "relationships": {
      "uleads": {
        "data": {
          "id": 355502,
          "type": "uleads"
        },
        "links": {
          "self": "https://uapi.cpahub.ru/v1/uleads/355502"
        }
      }
    }
  }
}
HTTP Status Code:200
data.idID лида
data.attributes.ulead_idID универсальной заявки
data.attributes.offer_idID оффера
data.attributes.statusСтатус лида:
queuedНе обработана
acceptedПринята рекламодателем
rejectedОтклонена
data.attributes.created_atДата и время создания лида
data.attributes.before_adv_errorsОшибки, обнаруженные перед отправкой лида. Конверсии по таким лидам не создаются.
data.attributes.errorsОшибки, обнаруженные рекламодетелем
data.attributes.conversion_idID конверсии, если была создана

Описание других полей см выше

По массиву лидов

В разработке...

Callbacks

Во время запроса на создание заявки, сервер возвращает статус запроса (rejected или accepted) и один из двух статусов для каждого лида (лид - заявка на конкретный оффер): rejected или queued. Лиды со статусом rejected не отправляются рекламодателю и по ним не создаются конверсии в ЛК/Hasoffers. Лиды со статусом queued ставятся в очередь на отправку рекламодателям и после отправки, создаются конверсии со статусом pending в ЛК/Hasoffers. Callback - это запрос, инициированный сервером Cpahub, позволяющий по результату отправки лида рекламодателю, получить информацию об изменении статуса лида с queued на rejected или accepted.

Для подключения функционала Callbacks обратитесь к вашему аккаунт-менеджеру, сообщив:

  • affiliate_id - ваш идентификатор в системе Cpahub
  • offer_id - идентификатор оффера в системе Cpahub
  • callback_url - адрес, по которому необходимо отправлять callback-запрос

После того как лид будет отправлен рекламодателю и сохранен в ЛК/Hasoffers, сервер Cpahub обратиться по указанному вами callback_url методом GET с параметрами ulead_id, lead_id и status.

Формат запроса: https://your-domain.com?ulead_id=<ulead_id>&lead_id=<lead_id>&status=<status>

Ваш сервер должен отправить в ответ HTTP Status Code: 200 (OK).

В случае, если ваш сервер ничего не ответил или вернул другой HTTP Status Code, сервер Cpahub предпримет еще 4 попытки сообщить об изменении статуса лида в течении суток. Если все 5 попыток безуспешны, сервер Cpahub перекратит информирование о смене статуса по данному лиду.

API Call Builder

Инструмент находится тут. Он позволяет:

  • выбрать параметры заявки и указать их значения
  • отправить запрос на сервер прямо со страницы
  • в ответ получить:
    • json-запрос
    • json-ответ сервера
    • примеры, как этот запрос можно отправить с консоли или в PHP

Инструмент поможет вам быстро протестировать любые запросы, ничего не программируя.

Справочники

Traffic source types

Стандарт: Cpahub standard

ID Название Описание
context Контекстная реклама
context_brand Контекст на бренд
seo Контентные сайты
retargeting Ретаргетинг
adspot AdSpot
richmedia RichMedia
sliding Sliding
email E-mail рассылка
email_spam E-mail спам
social_net Социальные сети
social_net_group Группы в социальных сетях
social_net_app Приложения в социальных сетях
discounter Скидочный агрегатор
coupon Купонный агрегатор
cashback Cashback
teaser Тизерные сети
banner Баннерные сети
mobile Мобильный трафик
mobile_mob Мобильный трафик для мобильной версии
brocker Брокерский трафик
forum Реклама на форумах
messenger Messenger
sms SMS рассылка
sms_spam SMS спам
push Push реклама
popup Pop-up
popunder Pop-under
clickunder Click-under
doorwey Дорвеи
motivational Мотивированный трафик
adult Adult
auto_redirect Авто-редирект
toolbar Toolbar реклама
apps Приложения и игры
coregistration Корегистрация
partisan Партизанский маркетинг
video Видеореклама
hypercontext Гиперконтекстная реклама
brand Реклама на бренд
rejects Отказной трафик
Reference relation

Стандарт: Cpahub standard

ID Название Описание
friend Friend
relative Relative
colleague Colleague
other Other
Gender

Стандарт: Cpahub standard

ID Название Описание
male Male
female Female
Семейный статус

Стандарт: Cpahub standard

ID Название Описание
married Married
single Single
divorced Divorced
widowed Widowed
civil Civil marriage
married_single Married but live alone
Occupation

Стандарт: Cpahub standard

ID Название Описание
worker Worker
unemployed Unemployed
pensioner Pensioner
student Student
student_correspondence Student correspondence
entrepreneur_person Entrepreneur person
entrepreneur_business Entrepreneur business
contract_worker Contract worker
regular_service Regular service
Образование

Стандарт: Cpahub standard

ID Название Описание
primary Начальное или неполное среднее
secondary Среднее
vocational Среднеспециальное
incomplete Неполное высшее
higher Высшее
higher_two_plus Два и более высших
academic Ученая степень
Страны

Стандарт: ISO_3166-1

ID Название Описание
AD Andorra
AE United Arab Emirates
AF Afghanistan
AG Antigua and Barbuda
AI Anguilla
AL Albania
AM Armenia
AO Angola
AQ Antarctica
AR Argentina
AS American Samoa
AT Austria
AU Australia
AW Aruba
AX Åland Islands
AZ Azerbaijan
BA Bosnia and Herzegovina
BB Barbados
BD Bangladesh
BE Belgium
BF Burkina Faso
BG Bulgaria
BH Bahrain
BI Burundi
BJ Benin
BL Saint Barthélemy
BM Bermuda
BN Brunei Darussalam
BO Bolivia
BQ Bonaire
BR Brazil
BS Bahamas
BT Bhutan
BV Bouvet Island
BW Botswana
BY Belarus
BZ Belize
CA Canada
CC Cocos (Keeling) Islands
CD Congo
CF Central African Republic
CG Congo
CH Switzerland
CI Côte d'Ivoire
CK Cook Islands
CL Chile
CM Cameroon
CN China
CO Colombia
CR Costa Rica
CU Cuba
CV Cabo Verde
CW Curaçao
CX Christmas Island
CY Cyprus
CZ Czechia
DE Germany
DJ Djibouti
DK Denmark
DM Dominica
DO Dominican Republic
DZ Algeria
EC Ecuador
EE Estonia
EG Egypt
EH Western Sahara
ER Eritrea
ES Spain
ET Ethiopia
FI Finland
FJ Fiji
FK Falkland Islands (Malvinas)
FM Micronesia
FO Faroe Islands
FR France
GA Gabon
GB United Kingdom
GD Grenada
GE Georgia
GF French Guiana
GG Guernsey
GH Ghana
GI Gibraltar
GL Greenland
GM Gambia
GN Guinea
GP Guadeloupe
GQ Equatorial Guinea
GR Greece
GS South Georgia and the South Sandwich Islands
GT Guatemala
GU Guam
GW Guinea-Bissau
GY Guyana
HK Hong Kong
HM Heard Island and McDonald Islands
HN Honduras
HR Croatia
HT Haiti
HU Hungary
ID Indonesia
IE Ireland
IL Israel
IM Isle of Man
IN India
IO British Indian Ocean Territory
IQ Iraq
IR Iran
IS Iceland
IT Italy
JE Jersey
JM Jamaica
JO Jordan
JP Japan
KE Kenya
KG Kyrgyzstan
KH Cambodia
KI Kiribati
KM Comoros
KN Saint Kitts and Nevis
KP Korea
KR Korea
KW Kuwait
KY Cayman Islands
KZ Kazakhstan
LA Lao People's Democratic Republic
LB Lebanon
LC Saint Lucia
LI Liechtenstein
LK Sri Lanka
LR Liberia
LS Lesotho
LT Lithuania
LU Luxembourg
LV Latvia
LY Libya
MA Morocco
MC Monaco
MD Moldova
ME Montenegro
MF Saint Martin
MG Madagascar
MH Marshall Islands
MK Macedonia
ML Mali
MM Myanmar
MN Mongolia
MO Macao
MP Northern Mariana Islands
MQ Martinique
MR Mauritania
MS Montserrat
MT Malta
MU Mauritius
MV Maldives
MW Malawi
MX Mexico
MY Malaysia
MZ Mozambique
NA Namibia
NC New Caledonia
NE Niger
NF Norfolk Island
NG Nigeria
NI Nicaragua
NL Netherlands
NO Norway
NP Nepal
NR Nauru
NU Niue
NZ New Zealand
OM Oman
PA Panama
PE Peru
PF French Polynesia
PG Papua New Guinea
PH Philippines
PK Pakistan
PL Poland
PM Saint Pierre and Miquelon
PN Pitcairn
PR Puerto Rico
PS Palestine
PT Portugal
PW Palau
PY Paraguay
QA Qatar
RE Réunion
RO Romania
RS Serbia
RU Russian Federation
RW Rwanda
SA Saudi Arabia
SB Solomon Islands
SC Seychelles
SD Sudan
SE Sweden
SG Singapore
SH Saint Helena
SI Slovenia
SJ Svalbard and Jan Mayen
SK Slovakia
SL Sierra Leone
SM San Marino
SN Senegal
SO Somalia
SR Suriname
SS South Sudan
ST Sao Tome and Principe
SV El Salvador
SX Sint Maarten
SY Syrian Arab Republic
SZ Eswatini
TC Turks and Caicos Islands
TD Chad
TF French Southern Territories
TG Togo
TH Thailand
TJ Tajikistan
TK Tokelau
TL Timor-Leste
TM Turkmenistan
TN Tunisia
TO Tonga
TR Turkey
TT Trinidad and Tobago
TV Tuvalu
TW Taiwan
TZ Tanzania
UA Ukraine
UG Uganda
UM United States Minor Outlying Islands
US United States of America
UY Uruguay
UZ Uzbekistan
VA Holy See
VC Saint Vincent and the Grenadines
VE Venezuela
VG Virgin Islands (British)
VI Virgin Islands (U.S.)
VN Viet Nam
VU Vanuatu
WF Wallis and Futuna
WS Samoa
YE Yemen
YT Mayotte
ZA South Africa
ZM Zambia
ZW Zimbabwe
AC Ascension Island
CP Clipperton Island
DG Diego Garcia
EA Ceuta
EU European Union
FX France
IC Canary Islands
SU USSR
TA Tristan da Cunha
UK United Kingdom
UN United Nations
Organization type

Стандарт: Cpahub standard

ID Название Описание
ooo ООО
aozt АОЗТ
pbojul ПБОЮЛ
oao ОАО
zao ЗАО
insurance_life Страхование Жизни
nou НОУ
superavto Суперавто
insurance_card Страхование Картдержателей
insurance_cash Страхование Наличности
ip ИП
chp ЧП
fl_p ФЛ-П
ano_do АНО ДО
muz МУЗ
gou_vpo ГОУ ВПО
komanditnoe Командитное Общество
judicial_instance Судебная Инстанция
people_enterprise АО РАБОТНИКОВ НАРОДНОЕ ПРЕДПРИЯТИЕ
joint_stock Акционерное Производственно Коммерческое Оо
anoo АНОО
artel_of_starators Артель Старателей
ano АНО
association Ассоциация
association_of_farms Ассоциация Крестьянских Хозяйств
health_spa_association Ассоциация Санаторно Курортное Объединение
association_of_housing_owners Ассоциация Товариществ Собственников Жилья
gu_fsin ГУ ФСИН
gono ГОНО
state_enterprise Государственное Казенное Предприятие
gp ГП
gpp ГПП
gup ГУП
gu ГУ
department_land_resources Департамент Земельных Ресурсов
doao ДОАО
zhsk ЖСК
collegium_of_advocates Коллегия Адвокатов
kolhoz Колхоз
kzhhsz КЖХСЗ
zhkh_committee Комитет По Жкх И Обслуживанию Населения
kommanditnoe Коммандитное Товарищество
farm Крестьянское Фермерское Хозяйство
medical Лечебно Профилактическое Учреждение
international_center Международный Центр
multiple_industrial Многоотраслевое Производственное Объединение
mp МП
mup МУП
mu МУ
non_profit Некоммерческая Организация
non_commercialpatnership Некоммерческое Партнерство
subdivision Обособленное Подразделение
subdivision_ooo Обособленное Подразделение Ооо
educational Образовательное Учреждение
ood ООД
social Общественная Организация
with_additional_responsibility Общество С Дополнительной Ответственностью
ono ОНО
department Отделение Организации
full_partnership Полное Товарищество
consumer_construction_cooperative Потребительский Жилищно Строительный Кооператив
consumer_society Потребительское Общество
artel_of_starters Производственная Артель Старателей
production_commercial_aozt Производственно Коммерческое Аозт
production_building_cooperative Производственно Строительный Кооператив
production_cooperative Производственный Кооператив
production_agricultural_cooperative Производственный Сельскохозяйственный Кооператив
fishing_artel Рыболовецкая Артель
health_resort_institution Санаторно Курортное Учреждение
agricultural_arter Сельскохозяйственная Артель
agricultural_cooperative Сельскохозяйственный Кооператив
consumer_societies_union Союз Потребительских Обществ
partnership_on_faith Товарищество На Вере
partnership_in_faith Товарищество На Вере Коммандитное Товарищество
partnership_on_faith_jsc Товарищество На Вере Оао
tszh ТСЖ
chamber_of_commerce_and_industry Торгово Промышленная Палата
up УП
institution Учреждение
federal_budgetary_institution Федеральное Бюджетное Учреждение
fgup ФГУП
federal_state_institution Федеральное Государственное Учреждение
federal_state_enterprise Федеральное Казенное Предприятие
federal_institution Федеральное Учреждение
branch Филиал
branch_gup Филиал Гуп
branch_zao Филиал Зао
consumer_society_regional_branch Филиал Областного Потребительского Общества
branch_ooo Филиал Ооо
branch_oao Филиал Оао
branch_fgup Филиал Фгуп
limited_liability_company ФИРМА С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ
fund ФОНД
private_institution Частное Учреждение
insurance_company Страховая Компания
nchou НЧОУ
district_consumer_society Районное Потребительское Общество
urban_consumer_society Городское Потребительское Общество
mdou МДОУ
nudo НУДО
financial_production_cooperative Финансовый Производственный Кооператив
chou ЧОУ
farm_peasant_economy Фермерско-крестьянское Хозяйство
gauz ГАУЗ
individual_entrepreneur Индивидуальный Предприниматель
local_department Местное Отделение Оого
federal_state_budgetary Федеральное Государственное Бюджетное Учреждение
gbuz ГБУЗ
private_educational Частное Образовательное Учреждение Дополнительного
au АУ
ao АО
ochu_cdo ОЧУ ЦДО
nochu НОЧУ
chu_dpo ЧУ ДПО
ogaou ОГАОУ
private_pension_fund Негосударственный Пенсионный Фонд
ano_dpo АНО ДПО
choudo ЧОУДО
aono_vpo АОНО ВПО
non_public_joint_stock_company Непубличное Акционерное Общество
district_consumer_cooperative Районный Потребительский Кооператив
consumer_cooperative Потребительский Кооператив
chu_spo ЧУ СПО
chupo ЧУПО
non_profit_expert Автономная Некоммерческая Экспертная Организация
chou_dpo ЧОУ ДПО
rural_consumer_society Сельское Потребительское Общество
pao ПАО
Виды экономической деятельности

Стандарт: ОКВЭД-2

ID Название Описание
farming Растениеводство и животноводство, охота и предоставление соответствующих услуг в этих областях
forestry Лесоводство и лесозаготовки
fish_farming Рыболовство и рыбоводство
coal_mining Добыча угля
extraction_oil_gas Добыча сырой нефти и природного газа
metal_mining Добыча металлических руд
mining_other Добыча прочих полезных ископаемых
mining_services Предоставление услуг в области добычи полезных ископаемых
food Производство пищевых продуктов
beverage Производство напитков
tobacco Производство табачных изделий
textiles Производство текстильных изделий
clothing Производство одежды
leather Производство кожи и изделий из кожи
wood_processing Обработка древесины и производство изделий из дерева и пробки, кроме мебели, производство изделий из соломки и материалов для плетения
paper Производство бумаги и бумажных изделий
printing Деятельность полиграфическая и копирование носителей информации
petroleum Производство кокса и нефтепродуктов
chemicals Производство химических веществ и химических продуктов
medical_products Производство лекарственных средств и материалов, применяемых в медицинских целях
rubber_plastic Производство резиновых и пластмассовых изделий
mineral Производство прочей неметаллической минеральной продукции
metallurgy Производство металлургическое
non_machinery_metal Производство готовых металлических изделий, кроме машин и оборудования
electronic Производство компьютеров, электронных и оптических изделий
electrical_products Производство электрического оборудования
machinery Производство машин и оборудования, не включенных в другие группировки
vehicles Производство автотранспортных средств, прицепов и полуприцепов
vehicles_other Производство прочих транспортных средств и оборудования
furniture Производство мебели
manufacturing_other Производство прочих готовых изделий
machinery_repair Ремонт и монтаж машин и оборудования
electricity_etc_supply Обеспечение электрической энергией, газом и паром; кондиционирование воздуха
water Забор, очистка и распределение воды
wastewater Сбор и обработка сточных вод
waste Сбор, обработка и утилизация отходов; обработка вторичного сырья
pollution_services Предоставление услуг в области ликвидации последствий загрязнений и прочих услуг, связанных с удалением отходов
construction_building Строительство зданий
construction_engineering Строительство инженерных сооружений
construction Работы строительные специализированные
vehicles_sale_repair Торговля оптовая и розничная автотранспортными средствами и мотоциклами и их ремонт
wholesale Торговля оптовая, кроме оптовой торговли автотранспортными средствами и мотоциклами
retail Торговля розничная, кроме торговли автотранспортными средствами и мотоциклами
land_pipeline_transport Деятельность сухопутного и трубопроводного транспорта
water_transport Деятельность водного транспорта
air_space_transport Деятельность воздушного и космического транспорта
warehousing Складское хозяйство и вспомогательная транспортная деятельность
postal Деятельность почтовой связи и курьерская деятельность
hospitality Деятельность по предоставлению мест для временного проживания
restaurant Деятельность по предоставлению продуктов питания и напитков
publishing Деятельность издательская
media_production Производство кинофильмов, видеофильмов и телевизионных программ, издание звукозаписей и нот
broadcasting Деятельность в области телевизионного и радиовещания
telecom Деятельность в сфере телекоммуникаций
software Разработка компьютерного программного обеспечения, консультационные услуги в данной области и другие сопутствующие услуги
it Деятельность в области информационных технологий
financial_services Деятельность по предоставлению финансовых услуг, кроме услуг по страхованию и пенсионному обеспечению
insurance Страхование, перестрахование, деятельность негосударственных пенсионных фондов, кроме обязательного социального обеспечения
financial_services_other Деятельность вспомогательная в сфере финансовых услуг и страхования
real_estate Операции с недвижимым имуществом
legal_and_accounting Деятельность в области права и бухгалтерского учета
headquarters Деятельность головных офисов; консультирование по вопросам управления
architecture_engineering Деятельность в области архитектуры и инженерно-технического проектирования; технических испытаний, исследований и анализа
rnd Научные исследования и разработки
marketing Деятельность рекламная и исследование конъюнктуры рынка
scientific_technical Деятельность профессиональная научная и техническая прочая
veterinary Деятельность ветеринарная
rental Аренда и лизинг
recruitment Деятельность по трудоустройству и подбору персонала
travel Деятельность туристических агентств и прочих организаций, предоставляющих услуги в сфере туризма
security Деятельность по обеспечению безопасности и проведению расследований
building_maintenance Деятельность по обслуживанию зданий и территорий
administrative Деятельность административно-хозяйственная, вспомогательная деятельность по обеспечению функционирования организации, деятельность по предоставлению прочих вспомогательных услуг для бизнеса
government Деятельность органов государственного управления по обеспечению военной безопасности, обязательному социальному обеспечению
education Образование
health_care Деятельность в области здравоохранения
residential_care Деятельность по уходу с обеспечением проживания
social_services Предоставление социальных услуг без обеспечения проживания
creative Деятельность творческая, деятельность в области искусства и организации развлечений
culture Деятельность библиотек, архивов, музеев и прочих объектов культуры
gaming Деятельность по организации и проведению азартных игр и заключению пари, по организации и проведению лотерей
sport_entertainment Деятельность в области спорта, отдыха и развлечений
public_org Деятельность общественных организаций
repair Ремонт компьютеров, предметов личного потребления и хозяйственно-бытового назначения
personal_services_other Деятельность по предоставлению прочих персональных услуг
household Деятельность домашних хозяйств с наемными работниками
households Деятельность недифференцированная частных домашних хозяйств по производству товаров и предоставлению услуг для собственного потребления
extraterritorial Деятельность экстерриториальных организаций и органов
Credit history

Стандарт: Cpahub standard

ID Название Описание
never Никогда не брал кредит
open_no_delay Кредиты есть, просрочек нет
open_had_delay Кредиты есть, просрочки были, сейчас нет
open_has_delay Кредиты есть, просрочки сейчас есть
closed_no_delay Кредиты закрыты, просрочек не было
closed_had_delay Кредиты закрыты, просрочки были
Currency

Стандарт: ISO 4217

ID Название Описание
AED AED United Arab Emirates dirham
AFN AFN Afghan afghani
ALL ALL Albanian lek
AMD AMD Armenian dram
ANG ANG Netherlands Antillean guilder
AOA AOA Angolan kwanza
ARS ARS Argentine peso
AUD AUD Australian dollar
AWG AWG Aruban florin
AZN AZN Azerbaijani manat
BAM BAM Bosnia and Herzegovina convertible mark
BBD BBD Barbados dollar
BDT BDT Bangladeshi taka
BGN BGN Bulgarian lev
BHD BHD Bahraini dinar
BIF BIF Burundian franc
BMD BMD Bermudian dollar
BND BND Brunei dollar
BOB BOB Boliviano
BOV BOV Bolivian Mvdol (funds code)
BRL BRL Brazilian real
BSD BSD Bahamian dollar
BTN BTN Bhutanese ngultrum
BWP BWP Botswana pula
BYN BYN Belarusian ruble
BZD BZD Belize dollar
CAD CAD Canadian dollar
CDF CDF Congolese franc
CHE CHE WIR Euro (complementary currency)
CHF CHF Swiss franc
CHW CHW WIR Franc (complementary currency)
CLF CLF Unidad de Fomento (funds code)
CLP CLP Chilean peso
CNY CNY Renminbi (Chinese) yuan
COP COP Colombian peso
COU COU Unidad de Valor Real (UVR) (funds code)
CRC CRC Costa Rican colon
CUC CUC Cuban convertible peso
CUP CUP Cuban peso
CVE CVE Cape Verde escudo
CZK CZK Czech koruna
DJF DJF Djiboutian franc
DKK DKK Danish krone
DOP DOP Dominican peso
DZD DZD Algerian dinar
EGP EGP Egyptian pound
ERN ERN Eritrean nakfa
ETB ETB Ethiopian birr
EUR EUR Euro
FJD FJD Fiji dollar
FKP FKP Falkland Islands pound
GBP GBP Pound sterling
GEL GEL Georgian lari
GHS GHS Ghanaian cedi
GIP GIP Gibraltar pound
GMD GMD Gambian dalasi
GNF GNF Guinean franc
GTQ GTQ Guatemalan quetzal
GYD GYD Guyanese dollar
HKD HKD Hong Kong dollar
HNL HNL Honduran lempira
HRK HRK Croatian kuna
HTG HTG Haitian gourde
HUF HUF Hungarian forint
IDR IDR Indonesian rupiah
ILS ILS Israeli new shekel
INR INR Indian rupee
IQD IQD Iraqi dinar
IRR IRR Iranian rial
ISK ISK Icelandic króna
JMD JMD Jamaican dollar
JOD JOD Jordanian dinar
JPY JPY Japanese yen
KES KES Kenyan shilling
KGS KGS Kyrgyzstani som
KHR KHR Cambodian riel
KMF KMF Comoro franc
KPW KPW North Korean won
KRW KRW South Korean won
KWD KWD Kuwaiti dinar
KYD KYD Cayman Islands dollar
KZT KZT Kazakhstani tenge
LAK LAK Lao kip
LBP LBP Lebanese pound
LKR LKR Sri Lankan rupee
LRD LRD Liberian dollar
LSL LSL Lesotho loti
LYD LYD Libyan dinar
MAD MAD Moroccan dirham
MDL MDL Moldovan leu
MGA MGA Malagasy ariary
MKD MKD Macedonian denar
MMK MMK Myanmar kyat
MNT MNT Mongolian tögrög
MOP MOP Macanese pataca
MRU MRU Mauritanian ouguiya
MUR MUR Mauritian rupee
MVR MVR Maldivian rufiyaa
MWK MWK Malawian kwacha
MXN MXN Mexican peso
MXV MXV Mexican Unidad de Inversion (UDI) (funds code)
MYR MYR Malaysian ringgit
MZN MZN Mozambican metical
NAD NAD Namibian dollar
NGN NGN Nigerian naira
NIO NIO Nicaraguan córdoba
NOK NOK Norwegian krone
NPR NPR Nepalese rupee
NZD NZD New Zealand dollar
OMR OMR Omani rial
PAB PAB Panamanian balboa
PEN PEN Peruvian sol
PGK PGK Papua New Guinean kina
PHP PHP Philippine peso[14]
PKR PKR Pakistani rupee
PLN PLN Polish złoty
PYG PYG Paraguayan guaraní
QAR QAR Qatari riyal
RON RON Romanian leu
RSD RSD Serbian dinar
RUB RUB Russian ruble
RWF RWF Rwandan franc
SAR SAR Saudi riyal
SBD SBD Solomon Islands dollar
SCR SCR Seychelles rupee
SDG SDG Sudanese pound
SEK SEK Swedish krona/kronor
SGD SGD Singapore dollar
SHP SHP Saint Helena pound
SLL SLL Sierra Leonean leone
SOS SOS Somali shilling
SRD SRD Surinamese dollar
SSP SSP South Sudanese pound
STN STN São Tomé and Príncipe dobra
SVC SVC Salvadoran colón
SYP SYP Syrian pound
SZL SZL Swazi lilangeni
THB THB Thai baht
TJS TJS Tajikistani somoni
TMT TMT Turkmenistan manat
TND TND Tunisian dinar
TOP TOP Tongan paʻanga
TRY TRY Turkish lira
TTD TTD Trinidad and Tobago dollar
TWD TWD New Taiwan dollar
TZS TZS Tanzanian shilling
UAH UAH Ukrainian hryvnia
UGX UGX Ugandan shilling
USD USD United States dollar
USN USN United States dollar (next day) (funds code)
UYI UYI Uruguay Peso en Unidades Indexadas (URUIURUI) (funds code)
UYU UYU Uruguayan peso
UYW UYW Unidad previsional
UZS UZS Uzbekistan som
VES VES Venezuelan bolívar soberano
VND VND Vietnamese đồng
VUV VUV Vanuatu vatu
WST WST Samoan tala
XAF XAF CFA franc BEAC
XAG XAG Silver (one troy ounce)
XAU XAU Gold (one troy ounce)
XBA XBA European Composite Unit (EURCO) (bond market unit)
XBB XBB European Monetary Unit (E.M.U.-6) (bond market unit)
XBC XBC European Unit of Account 9 (E.U.A.-9) (bond market unit)
XBD XBD European Unit of Account 17 (E.U.A.-17) (bond market unit)
XCD XCD East Caribbean dollar
XDR XDR Special drawing rights
XOF XOF CFA franc BCEAO
XPD XPD Palladium (one troy ounce)
XPF XPF CFP franc (franc Pacifique)
XPT XPT Platinum (one troy ounce)
XSU XSU SUCRE
XTS XTS Code reserved for testing purposes
XUA XUA ADB Unit of Account
XXX XXX No currency
YER YER Yemeni rial
ZAR ZAR South African rand
ZMW ZMW Zambian kwacha
ZWL ZWL Zimbabwean dollar
Card type

Стандарт: Cpahub standard

ID Название Описание
credit Credit
installment Installment
Payment system

Стандарт: Cpahub standard

ID Название Описание
mc MASTERCARD
visa VISA
amex AMEX
cup CUP

Загрузка заявок с помощью csv-файла

Процедура
  1. Подготовьте csv-файл
    • формат должен соответствовать стандарту RFC4180
    • в первой строке обязательно должны быть заголовки полей
    • заголовки полей должны соответствовать соглашению о наименованиях ниже
  2. Отправьте файл своему менедежеру. Менеджер загрузит файл и сообщит вам результат. Чуть позже так же будет реализована возможность самостоятельной загрузки файла в Личном кабинете.
Соглашение о наименованиях полей заголовка csv-файла
  • наименования соответствуют названиям полей из документации
  • не используются следующие поля: affiliate_id, api_key, is_test, validation, queueing, delivery
  • остальные поля используются, конкретный набор полей определяется оффером
  • неиспользуемые поля будут проигнорированы
Замечания по значениям в полях
  • пропуск значения интерпретируется как null
  • для полей типа boolean, значение 0 соответствует false, значение 1 соответствует true

Пример файла с тремя заявками для оффера 727:

affiliate_info1,personal_data.is_granted,second_name,first_name,cell_phone
"tag1",1,Петров,Сергей,9163180000
"tag1",1,Иванов,Андрей,9163180001
"tag2",1,Сидоров,Николай,9163180002