API документация – интеграция платформы CXDP

Авторизация

Для каждого запроса необходимо передавать header

Authorization: Bearer #{token}, где токен это api_key.

Импорт (поштучный)

Для создания профиля необходимо отправить POST запрос на /api/outer_v1/import/cdp_profile

Поля:

'pixel_id' => 'required|integer',

# ID пикселя, который есть в компании 'personal_name' => 'string|max:255',

'personal_surname' => 'string|max:255',

'bio_birth' => 'date|nullable',

'personal_phone' => 'string|max:255',

'personal_email' => 'string|max:255',

'personal_city' => 'string|max:255',

'personal_country' => 'string|max:255',

'bio_gender' => 'string|max:255',

'mailing_consent' => 'boolean',

'mac_address' => 'string|max:255',

Импорт (массовый)

Для массового импорта необходимо отправить POST запрос на /api/outer_v1/import/cdp_profiles

Поля:

'pixel_id' => 'required|integer', # ID пикселя, который есть в компании 'file' => 'required' # csv file

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

personal_name, personal_surname, bio_birth, personal_phone, personal_email, personal_city, personal_country, bio_gender, bio_weight, bio_height

Для получения статуса импорта необходимо отправить GET запрос /api/outer_v1/import/cdp_profiles/{id}, где id это ID импорта

Будут возвращены следующие поля:

company_id pixel_id state progress file_file_name file_file_size file_content_type file_updated_at

Получение содержимого профиля

Для получения содержимого профиля, необходимо отправить GET запрос на /api/outer_v1/cdp_profiles/{id}, где id это ID профиля

Удаление профиля

Для удаления профиля, необходимо отправить DELETE запрос на /api/outer_v1/cdp_profiles/{id}, где id это ID профиля

Проверка существования профиля

Для проверки существования профиля, необходимо отправить POST запрос на api/outer_v1/cdp_profiles/exists, где id это ID профиля

Поля:

'id' => 'required|integer', # ID профиля

Если профиль существует, ответ будет со статусом 200, если нет, то со статусом 404

Список профилей

Для получения списка профилей, необходимо отправить GET запрос на /api/outer_v1/cdp_profiles

Если нужно отфильтровать список пользователей, необходимо отправить запрос с параметром filter, /api/outer_v1/cdp_profiles?filter=#{filter}

Формат фильтра:

{

"condition": "AND",

"rules": [

{

"id": "personal_name",

"field": "cdp_profiles.personal_name",

"type": "string",

"input": "text",

"operator": "equal",

"value": "ivan"

}],

"valid": true

}

Пагинация api/outer_v1/cdp_profiles?page=1

Создание сегмента

Для создания сегмента, необходимо отправить POST запрос на /api/outer_v1/cdp_segments

Поля:

'name' => 'required|string|max:255',

'filter' => 'string',

'company_id' => 'required|integer'

Получить сегмент

Для получения сегмента, необходимо отправить GET запрос на /api/outer_v1/segments/{id}, где id это ID сегмента

Получить профили сегмента

Для получения профилей сегмента, необходимо отправить GET запрос на /api/outer_v1/segments/{id}/profiles, где id это ID сегмента

Создание Look alike'а

Для создания look_a_likes, необходимо отправить POST запрос на /api/outer_v1/look_a_likes

Поля:

'name' => 'required|string|max:255',

'cdp_segment_id' => 'required|integer', # ID сегмента

'precision' => 'required|integer' # от 0 до 100

Проверка баланса

Для проверки баланса компании, необходимо отправить GET запрос на /api/outer_v1/my_company/balance