API пользователя
Space shortcuts
Page tree
Skip to end of metadata
Go to start of metadata

Используется в API запросах, связанных с импортом подписчиков в базы данных. В объекте передаются значения полей базы и подписки.

Информацию о всех полях конретной базы данных можно получить по запросу к api/v1.1/databases/fields_get/

Общая информация о базах данных и используемых полях доступна в пользовательской документации.

JSON

{
    "data": {
        "_regcountry": "US",
		"_regcity": "New York",
		"_regip": "94.231.119.122",
		"_regurl": "www.example.com",
		"_regdate": "2019-03-14T22:00:00Z",
		"_bdate": "1990-02-22T21:00:00Z",
        "_browser": "Thunderbird",
        "_city": "Ryazan",
        "_country": "RU",
        "_fname": "Olly",
        "_ip": "94.231.119.122",
        "_lname": "Lambert",
        "_postal_code": "390000",
        "_region": "Ryazan Oblast",
		"_vendor": "form_#31",
		"_sex": 0,
        "_status": 0,
        "_tz": "Europe/Moscow",
		"email": "example@altcraft.com",
		"phones": ["+790000000000"],
		"custom_field": "custom_value"
		"subscriptions": [
            {
                "channel": "email",
                "email": "boris.yudaev@altcraft.com",
                "priority": 0              
                "resource_id": 1,
                "status": 0
            }
        ]
 }

Описание

ПараметрТипПримерОписание
_bdate
string
1990-02-22T21:00:00Z
Дата рождения
_browser
stringFirefoxБраузер
_city
stringRyazanГород
_country
stringRUСтрана в формате TLD
_fnamestringOllyИмя
_ip
string
94.231.119.122
IP адрес*
_lname
stringLambertФамилия
_postal_code
int
390000
Почтовый индекс
_region
string
Ryazan Oblast
Регион
_status
int0Глобальный статус подписки
_tz
stringEurope/MoscowЧасовой пояс
email
stringexample@altcraft.comАдрес электронной почты
phones
JSON array
["+790000000000"]
Номера телефонов
subscriptionsJSON array
["",""]
Подписки профиля
custom_field
*custom_value

Дополнительные поля базы данных.

Возможно функциональное обновление полей. Для этого необходимо указать действие (action) и значение (value).

Пример запроса для увеличения  значения поля:

"custom_field": {
	"action": "incr",
	"value": 1000
}
_regcountry
stringUSСтрана регистрации в формате TLD
_regcity
stringNew YorkГород регистрации
_regip
string
94.231.119.122
Ip регистрации
_regurlstringwww.example.orgURL регистрации
_regdatestring
2018-02-22T21:00:00Z
Дата регистрации
_sexint0Идентификатор Пола, указывается согласно Список гендерных идентификаций
_vendorstringform#33Форма сбора данных клиентов

* При передаче в запросе на импорт IP адреса в формате IPv4 платформа автоматически определяет местоположение подписчика и записывает следующие системные поля данных:


{
	"_ip": "94.231.119.122", (уже добавляется само по себе)
	"_lat": 54.6197, (географическая широта)
	"_lon": 39.74, (географическая долгота)
	"_postal_code": "390000", 
	"_region": "Ryazanskaya Oblast'",
	"_country": "RU",
	"_city": "Ryazan",
	"_tz": "Europe/Moscow"
}



  • No labels