Skip to content

LeadCraft API Documentation

Описание

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

  • type - тип интеграции [lead]
  • api_token - токен для аутентификации (можно получить в личном кабинете или у менеджера)
  • applied_at - дата заполнения заявки клиентом
  • sales[].campaignID - массив campaignID тех офферов, в которые нужно отправлять лиды

Подробнее смотрите в пункте "Данные запроса"

Пример запроса

curl --request POST --header "content-type:application/json"
"https://api.leadcraft.ru/v1/webmasters/lead" -d 'Данные для запроса'

Примеры ответов

HTTP_CREATED (201)

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

{"id":234,"status":"received","details":{"e435e95f-6dd0-4df5-bae3-26c47a710f80":{"status":"accepted"}}}

HTTP_FORBIDDEN (403)

api_token не указан или указан неверно

{"code":403,"message":"AuthorizationException"}

Данные запроса

Системные поля

Используются для идентификации лидов и их продажи

Название Обязательность Описание
type

Тип лидов

lead
api_token

Токен для аутентификации

Получить в кабинете или у менеджера
product

Идентификатор типа трафика

1 - Кредитный трафик, 2 - Банкротство
applied_at

Дата заполнения заявки клиентом

Дата в формате (ГГГГ-MM-ДД ЧЧ:ММ:СС)
stream

Идентификатор потока

Строка, максимально 64 символа. Может содержать символы: A-Z a-z 0-9
Meta
Мета информация, метки
meta.is_test

Определяет, тестовый лид или боевой

Одно из значений=> [false, true]. По умолчанию: false
meta.sub1

Сабаккаунт 1

Может быть null. Должна быть строка. Максимально 64 символа. Может содержать символы: A-Z a-z 0-9 - _
meta.sub2

Сабаккаунт 2

Может быть null. Должна быть строка. Максимально 64 символа. Может содержать символы: A-Z a-z 0-9 - _
meta.sub3

Сабаккаунт 3

Может быть null. Должна быть строка. Максимально 64 символа. Может содержать символы: A-Z a-z 0-9 - _
meta.sub4

Сабаккаунт 4

Может быть null. Должна быть строка. Максимально 64 символа. Может содержать символы: A-Z a-z 0-9 - _
meta.sub5

Сабаккаунт 5

Может быть null. Должна быть строка. Максимально 64 символа. Может содержать символы: A-Z a-z 0-9 - _
Sales
Данные о продаже
sales[].campaignID

ID рекламной кампании

Строка в формате UUID

Атрибуты

При выборе оффера документация динамически перестраивает обязательные поля. Если выбрать несколько офферов, в показанном результате будут учтены требования каждого из них. В примерах значений в аттрибутах, относящихся к адресам, использованы аббревиатуры из сервиса dadata

Название Обязательность Описание
user
first_name

Имя

От 2 до 50 символов. Может содержать только русские буквы. Разделительные символы(пробел)
father_name

Отчество

От 2 до 50 символов. Может содержать только русские буквы. Разделительные символы(пробел)
last_name

Фамилия

От 2 до 50 символов. Может содержать только русские буквы. Разделительные символы(пробел)
birth_date

Дата рождения

Формат: ГГГГ-ММ-ДД. 18-100 лет
birth_place

Место рождения

Строка. Макс: 500 символов
gender

Пол

Одно из значений: [f, m]
phone

Телефон

11 цифр
email

Email

Валидный email
ip

IP адрес

IPv4, IPv6
consent
status

Согласие на обработку персональных данных

Одно из значений: [true, false]
datetime

Дата согласия

Дата в формате (ГГГГ-MM-ДД ЧЧ:ММ:СС)
mailing_consent
status

Согласие на получение рассылок

Одно из значений: [true, false]
datetime

Дата согласия

Дата в формате (ГГГГ-MM-ДД ЧЧ:ММ:СС)
codes
snils

Строки. Макс: 12 симв.
inn

Строки. Макс: 12 симв.
passport
passport_seria

Серия паспорта

4 цифры
passport_number

Номер паспорта

6 цифры
passport_issuer

Гос. орган, выдавший паспорт

Строка. макс. 255 симв.
passport_issuer_code

Код гос. органа

Строка. макс. 20 симв.
passport_date

Дата выдачи паспорта

Дата в формате (ГГГГ-MM-ДД)
credit
amount

Сумма займа

Сумма в рублях. Цифра мин:0
term

Срок выплаты займа

Срок в днях. Цифры мин:0
income
salary

Зарплата

Сумма в рублях. Цифра мин:0
Addr Reg
Адрес Регистрации
addr_reg.address

Адрес регистрации

Строка. Макс: 500
addr_reg.equal_to_fact

Совпадает с адресом проживания

[true, false]
addr_reg.country

Страна

Строка. Mакс: 60. Одно из значений: [Россия]
addr_reg.country_iso

ISO код страны

Строка. Симв: 2. Одно из значений: [RU]
addr_reg.postal_code

Почтовый код

Строка. Симв: максимум 6.
addr_reg.region

Регион. Если нет региона, то параметры region, region_type в JSON оба должны быть null.

Строка. Макс: 60
addr_reg.region_type

Тип региона. Если передаете 'Тип региона', то обязательно нужно передавать 'Регион' - иначе ошибка

Строка. Макс: 20. Одно из значений: [АО, Аобл, край, обл, респ, округ, а.обл., а.окр., etc.]
addr_reg.region_fias_id

ФИАС ID региона

Строка. GUID, Макс: 36
addr_reg.region_kladr_code

КЛАДР код региона

13 цифр
addr_reg.region_area

Район. Если нет района, то параметры region_area, region_area_type в JSON оба должны быть null.

Строка. Макс: 60
addr_reg.region_area_type

Тип района. Если передаете 'Тип района', то обязательно нужно передавать 'Район' - иначе ошибка

Строка. Макс: 20. Одно из значений: [АО, р-н, у, тер, п, г, вн.тер. г., пос., etc.]
addr_reg.region_area_fias_id

ФИАС ID района

Строка. GUID, Макс: 36
addr_reg.region_area_kladr_code

КЛАДР код района

13 цифр
addr_reg.city

Город. Если нет города, то параметры city, city_type в JSON оба должны быть null.

Строка. Макс: 60
addr_reg.city_type

Тип города. Если передаете 'Тип города', то обязательно нужно передавать 'Город' - иначе ошибка

Строка. Макс: 20. Одно из значений: [г, пгт, рп, кп, дп, с/с, с/а, с/о, п/о, тер, с/п, с/мо, массив, etc.]
addr_reg.city_fias_id

ФИАС ID города

Строка. GUID, Макс: 36
addr_reg.city_kladr_code

КЛАДР код города

13 цифр
addr_reg.city_district

Район города. Если нет района города, то параметры city_district, city_district_type в JSON оба должны быть null.

Строка. Макс: 60
addr_reg.city_district_type

Тип района города. Если передаете 'Тип района города', то обязательно нужно передавать 'Район города' - иначе ошибка

Строка. Макс: 20
addr_reg.city_district_fias_id

ФИАС ID района города

Строка. GUID, Макс: 36
addr_reg.city_district_kladr_code

КЛАДР код района города

13 цифр
addr_reg.settlement

Населенный пункт. Если нет населенного пункта, то параметры settlement, settlement_type в JSON оба должны быть null.

Строка. Макс: 60
addr_reg.settlement_type

Тип населенного пункта. Если передаете 'Тип населенного пунта', то обязательно нужно передавать 'Населенный пункт' - иначе ошибка

Строка. Макс: 20. Одно из значений: [тер. ДНТ, ж/д ст, п, с, ж/р, д, тер. ОНО, п/о, снт, м, аул, п. ст., п/ст, п. ж/д ст., etc.]
addr_reg.settlement_fias_id

ФИАС ID населенного пункта

Строка. GUID, Макс: 36
addr_reg.settlement_kladr_code

КЛАДР код населенного пункта

13 цифр
addr_reg.street

Улица. Если нет улицы, то параметры street, street_type в JSON оба должны быть null.

Строка. Макс: 60
addr_reg.street_type

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

Строка. Макс: 20. Одно из значений: [б-р, въезд, дор, жт, заезд, кв-л, км, кольцо, линия, наб, остров, парк, пер, переезд, пл, etc.]
addr_reg.street_fias_id

ФИАС ID улицы

Строка. GUID, Макс: 36
addr_reg.street_kladr_code

КЛАДР код улицы

13 цифр
addr_reg.house

Дом. Если нет дома, то параметры house, house_type в JSON оба должны быть null.

Строка. Макс: 60
addr_reg.house_type

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

Строка. Макс: 20
addr_reg.block

Блок. Если нет блока, то параметры block, block_type в JSON оба должны быть null.

Строка. Макс: 60
addr_reg.block_type

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

Строка. Макс: 20
addr_reg.flat

Квартира. Если нет квартиры, то параметры flat, flat_type в JSON оба должны быть null.

Строка. Макс: 60
addr_reg.flat_type

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

Строка. Макс: 20
Addr Fact
Фактический адрес
addr_fact.address

Фактический адрес

Строка. Макс: 500
addr_fact.equal_to_reg

Совпадает с адресом регистрации

[true, false]
addr_fact.country

Страна

Строка. Mакс: 60. Одно из значений: [Россия]
addr_fact.country_iso

ISO код страны

Строка. Симв: 2. Одно из значений: [RU]
addr_fact.postal_code

Почтовый код

Строка. Симв: максимум 6.
addr_fact.region

Регион. Если нет региона, то параметры region, region_type в JSON оба должны быть null.

Строка. Макс: 60
addr_fact.region_type

Тип региона. Если передаете 'Тип региона', то обязательно нужно передавать 'Регион' - иначе ошибка

Строка. Макс: 20. Одно из значений: [АО, Аобл, край, обл, респ, округ, а.обл., а.окр., etc.]
addr_fact.region_fias_id

ФИАС ID региона

Строка. GUID, Макс: 36
addr_fact.region_kladr_code

КЛАДР код региона

13 цифр
addr_fact.region_area

Район. Если нет района, то параметры region_area, region_area_type в JSON оба должны быть null.

Строка. Макс: 60
addr_fact.region_area_type

Тип района. Если передаете 'Тип района', то обязательно нужно передавать 'Район' - иначе ошибка

Строка. Макс: 20. Одно из значений: [АО, р-н, у, тер, п, г, вн.тер. г., пос., etc.]
addr_fact.region_area_fias_id

ФИАС ID района

Строка. GUID, Макс: 36
addr_fact.region_area_kladr_code

КЛАДР код района

13 цифр
addr_fact.city

Город. Если нет города, то параметры city, city_type в JSON оба должны быть null.

Строка. Макс: 60
addr_fact.city_type

Тип города. Если передаете 'Тип города', то обязательно нужно передавать 'Город' - иначе ошибка

Строка. Макс: 20. Одно из значений: [г, пгт, рп, кп, дп, с/с, с/а, с/о, п/о, тер, с/п, с/мо, массив, etc.]
addr_fact.city_fias_id

ФИАС ID города

Строка. GUID, Макс: 36
addr_fact.city_kladr_code

КЛАДР код города

13 цифр
addr_fact.city_district

Район города. Если нет района города, то параметры city_district, city_district_type в JSON оба должны быть null.

Строка. Макс: 60
addr_fact.city_district_type

Тип района города. Если передаете 'Тип района города', то обязательно нужно передавать 'Район города' - иначе ошибка

Строка. Макс: 20
addr_fact.city_district_fias_id

ФИАС ID района города

Строка. GUID, Макс: 36
addr_fact.city_district_kladr_code

КЛАДР код района города

13 цифр
addr_fact.settlement

Населенный пункт. Если нет населенного пункта, то параметры settlement, settlement_type в JSON оба должны быть null.

Строка. Макс: 60
addr_fact.settlement_type

Тип населенного пункта. Если передаете 'Тип населенного пункта', то обязательно нужно передавать 'Населенный пункт' - иначе ошибка

Строка. Макс: 20. Одно из значений: [тер. ДНТ, ж/д ст, п, с, ж/р, д, тер. ОНО, п/о, снт, м, аул, п. ст., п/ст, п. ж/д ст., etc.]
addr_fact.settlement_fias_id

ФИАС ID населенного пункта

Строка. GUID, Макс: 36
addr_fact.settlement_kladr_code

КЛАДР код населенного пункта

13 цифр
addr_fact.street

Улица. Если нет улицы, то параметры street, street_type в JSON оба должны быть null.

Строка. Макс: 60
addr_fact.street_type

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

Строка. Макс: 20. Одно из значений: [б-р, въезд, дор, жт, заезд, кв-л, км, кольцо, линия, наб, остров, парк, пер, переезд, пл, etc.]
addr_fact.street_fias_id

ФИАС ID улицы

Строка. GUID, Макс: 36
addr_fact.street_kladr_code

КЛАДР код улицы

13 цифр
addr_fact.house

Дом. Если нет дома, то параметры house, house_type в JSON оба должны быть null.

Строка. Макс: 60
addr_fact.house_type

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

Строка. Макс: 20
addr_fact.block

Блок. Если нет блока, то параметры block, block_type в JSON оба должны быть null.

Строка. Макс: 60
addr_fact.block_type

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

Строка. Макс: 20
addr_fact.flat

Квартира. Если нет квартиры, то параметры flat, flat_type в JSON оба должны быть null

Строка. Макс: 60
addr_fact.flat_type

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

Строка. Макс: 20

Пример данных запроса

{
  "type"       : "lead",
  "applied_at" : "2022-01-19 15:45:31",
  "api_token"    : "1654247738.4279JNQpg18utYrsHnCc",
  "product" : 1,
  "stream" : "stream01",
  "meta"       : {
    "is_test"      : false,
    "sub1"         : "",
    "sub2"         : "",
    "sub3"         : "",
    "sub4"         : "",
    "sub5"         : ""
  },
  "sales" : [
    {
      "campaignID": "e435e95f-6dd0-4df5-bae3-26c47a710f80"
    },
    {
      "campaignID": "4cf38a91-0f30-4e3f-bdd9-00d86d901a81"
    }
  ],
  "attributes" : {
    "consent" : {
      "status"   : true,
      "datetime" : "2021-02-15 14:05:34"
    },
    "mailing_consent" : {
      "status"   : true,
      "datetime" : "2021-02-15 14:05:34"
    },
    "user" : {
      "first_name"  : "Александр",
      "father_name" : "Петрович",
      "last_name"   : "Иванов",
      "birth_date"  : "1986-04-17",
      "birth_place" : "Кишинев",
      "gender"      : "m",
      "phone"       : 79441234574,
      "email"       : "test@example.com",
      "ip"          : "192.168.0.23"
    },
    "codes" : {
      "snils" : "1234567890",
      "inn"   : "1234567890"
    },
    "passport" : {
      "seria"          : "1234",
      "number"         : "123456",
      "issuer"         : "Администрация президента",
      "issuer_code"    : "101",
      "date"           : "2011-05-03"
    },
    "credit"      : {
      "amount" : "10000",
      "term"   : 30
    },
    "income" : {
      "salary" : 100000
    },
    "addr_reg" : {
      "address"                    : "Тульская обл, г. Советск, ул. Краснодарская, д.1 кв.43",
      "postal_code"                : "123456",
      "country"                    : "Россия",
      "country_iso"                : "RU",
      "area_plain"                 : "Южный",
      "region"                     : "Тульская",
      "region_type"                : "обл",
      "region_fias_id"             : "d028ec4f-f6da-4843-ada6-b68b3e0efa3d",
      "region_kladr_code"          : "7100000000000",
      "region_area"                : "Щекинский",
      "region_area_type"           : "р-н",
      "region_area_fias_id"        : "41b58375-5128-4897-8b0b-0ce8b39acdaa",
      "region_area_kladr_code"     : "7102400000000",
      "city"                       : "Советск",
      "city_type"                  : "г",
      "city_fias_id"               : "20bde9d4-4295-417f-beba-6210f2e6b5d9",
      "city_kladr_code"            : "7102400200000",
      "city_district"              : "",
      "city_district_fias_id"      : "",
      "city_district_type"         : "",
      "city_district_kladr_id"     : "",
      "settlement"                 : "",
      "settlement_type"            : "",
      "settlement_fias_id"         : "",
      "settlement_kladr_id"        : "",
      "street"                     : "Краснодарская",
      "street_type"                : "ул",
      "street_fias_id"             : "7dfa745e-aa19-6547-b121-b655c11e482f",
      "street_kladr_code"          : "2300000130400",
      "house"                      : "1",
      "house_type"                 : "д",
      "block_num"                  : "",
      "block_type"                 : "",
      "flat_num"                   : "43",
      "flat_type"                  : "кв"
    },
    "addr_fact" : {
      "address"                    : "Московская область, г. Мытищи, ул. Тверская, д.56 кв.5",
      "postal_code"                : "123456",
      "country"                    : "Россия",
      "country_iso"                : "RU",
      "area_plain"                 : "Южный",
      "region"                     : "Московская",
      "region_type"                : "обл",
      "region_fias_id"             : "29251dcf-00a1-4e34-98d4-5c47484a36d4",
      "region_kladr_code"          : "5000000000000",
      "region_area"                : "",
      "region_area_type"           : "",
      "region_area_fias_id"        : "",
      "region_area_kladr_code"     : "",
      "city"                       : "Мытищи",
      "city_type"                  : "г",
      "city_fias_id"               : "5f290be7-14ff-4ccd-8bc8-2871a9ca9d5f",
      "city_kladr_code"            : "5000004400000",
      "city_district"              : "",
      "city_district_type"         : "",
      "city_district_fias_id"      : "",
      "city_district_kladr_id"     : "",
      "settlement"                 : "",
      "settlement_type"            : "",
      "settlement_fias_id"         : "",
      "settlement_kladr_id"        : "",
      "street"                     : "Тверская",
      "street_type"                : "ул",
      "street_fias_id"             : "1dda745e-aa25-6557-b121-b655c11e657d",
      "street_kladr_code"          : "5000000555400",
      "house"                      : "1",
      "house_type"                 : "д",
      "block_num"                  : "",
      "block_type"                 : "",
      "flat_num"                   : "5",
      "flat_type"                  : "кв"
    }
  }
}