{ "item": [ { "name": "api", "description": "", "item": [ { "name": "widgets", "description": "", "item": [ { "name": "data", "description": "", "item": [ { "id": "2352afe6-60ce-4788-a532-ed9f8ed0daf0", "name": "Получить конфигурацию виджетов для посетителя", "request": { "name": "Получить конфигурацию виджетов для посетителя", "description": { "content": "Клиентский widget.js вызывает этот endpoint при загрузке страницы.\nВозвращает активные виджеты для посетителя (по fingerprint),\nнастройки опросов, данные контакта (lead_score), и токен для\nподписки на Reverb-канал server-triggered виджетов.\n\nOrigin (из заголовка Origin/Referer) должен матчить один из\nзарегистрированных доменов в кабинете (таблица `user_domains`,\n`is_active=true`). Иначе 403.\n", "type": "text/plain" }, "url": { "path": [ "api", "widgets", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Browser fingerprint посетителя.", "type": "text/plain" }, "key": "fingerprint", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "09eccf06-5f38-4ab2-a2ba-9ec859a8b403", "name": "OK", "originalRequest": { "url": { "path": [ "api", "widgets", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Browser fingerprint посетителя.", "type": "text/plain" }, "key": "fingerprint", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"widgets\": [\n {\n \"id\": \"\",\n \"type\": \"tooltip\",\n \"title\": \"\",\n \"settings\": {\n \"key_0\": 7247\n },\n \"rules\": {\n \"key_0\": 9936.133487224459,\n \"key_1\": \"string\"\n },\n \"ab_test\": {\n \"variant_id\": \"\",\n \"settings_override\": {}\n }\n },\n {\n \"id\": \"\",\n \"type\": \"tooltip\",\n \"title\": \"\",\n \"settings\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 5288.131061291056\n },\n \"rules\": {\n \"key_0\": \"string\",\n \"key_1\": 7761\n },\n \"ab_test\": {\n \"variant_id\": \"\",\n \"settings_override\": {}\n }\n }\n ],\n \"surveys\": {\n \"csat_enabled\": \"\",\n \"csat_template\": {\n \"key_0\": 130,\n \"key_1\": 6389\n }\n },\n \"contact\": {\n \"lead_score\": \"\",\n \"lead_score_tier\": \"warm\"\n },\n \"broadcast_token\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6fa9c63-0cca-4094-bbb6-a5e3cb3b0ea1", "name": "Отсутствует fingerprint", "originalRequest": { "url": { "path": [ "api", "widgets", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Browser fingerprint посетителя.", "type": "text/plain" }, "key": "fingerprint", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b64b7f5b-8266-4d5e-82a7-7fc568ab4c37", "name": "Отсутствует или некорректный API-ключ", "originalRequest": { "url": { "path": [ "api", "widgets", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Browser fingerprint посетителя.", "type": "text/plain" }, "key": "fingerprint", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "059aab91-8553-4afb-b52f-e8959ff3208f", "name": "Ключ не найден или подписка неактивна", "originalRequest": { "url": { "path": [ "api", "widgets", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Browser fingerprint посетителя.", "type": "text/plain" }, "key": "fingerprint", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0dd2f3d-df25-49ea-afba-449ec14fb3fd", "name": "Превышен rate limit (см. `x-rateLimit`)", "originalRequest": { "url": { "path": [ "api", "widgets", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Browser fingerprint посетителя.", "type": "text/plain" }, "key": "fingerprint", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Секунд до сброса счётчика", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd7bf846-d151-4d87-a91f-40cdcb88fa50", "name": "Внутренняя ошибка сервера", "originalRequest": { "url": { "path": [ "api", "widgets", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Browser fingerprint посетителя.", "type": "text/plain" }, "key": "fingerprint", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "log", "description": "", "item": [ { "id": "7e4a4935-9f4c-4646-8610-e44129659474", "name": "Логировать взаимодействие посетителя с виджетом", "request": { "name": "Логировать взаимодействие посетителя с виджетом", "description": { "content": "Записывает событие показа/клика/submit'а/dismiss'а виджета.\nОбновляет счётчики `contact_widget_stats` (для frequency\ncapping'а). Может триггерить outbound webhook'и\n(`widget_show` / `widget_click` / `widget_submit`).\n", "type": "text/plain" }, "url": { "path": [ "api", "widgets", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"action\": \"widget_click\",\n \"widget_id\": \"\",\n \"widget_ids\": [\n \"\",\n \"\"\n ],\n \"additional_data\": {\n \"key_0\": \"string\",\n \"key_1\": 9939,\n \"key_2\": true,\n \"key_3\": 3141\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "636fa786-90fa-4fd7-bdb3-1476dece2898", "name": "OK", "originalRequest": { "url": { "path": [ "api", "widgets", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"action\": \"widget_click\",\n \"widget_id\": \"\",\n \"widget_ids\": [\n \"\",\n \"\"\n ],\n \"additional_data\": {\n \"key_0\": \"string\",\n \"key_1\": 9939,\n \"key_2\": true,\n \"key_3\": 3141\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "734d8f1f-2691-446b-8a4e-25ca572b7a06", "name": "Отсутствует или некорректный API-ключ", "originalRequest": { "url": { "path": [ "api", "widgets", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"action\": \"widget_click\",\n \"widget_id\": \"\",\n \"widget_ids\": [\n \"\",\n \"\"\n ],\n \"additional_data\": {\n \"key_0\": \"string\",\n \"key_1\": 9939,\n \"key_2\": true,\n \"key_3\": 3141\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "528c165c-bc39-44ea-8c96-b5ce39517019", "name": "Ключ не найден или подписка неактивна", "originalRequest": { "url": { "path": [ "api", "widgets", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"action\": \"widget_click\",\n \"widget_id\": \"\",\n \"widget_ids\": [\n \"\",\n \"\"\n ],\n \"additional_data\": {\n \"key_0\": \"string\",\n \"key_1\": 9939,\n \"key_2\": true,\n \"key_3\": 3141\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9df8adc2-c98a-4530-ad08-21f36138f56c", "name": "Ошибка валидации полей запроса", "originalRequest": { "url": { "path": [ "api", "widgets", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"action\": \"widget_click\",\n \"widget_id\": \"\",\n \"widget_ids\": [\n \"\",\n \"\"\n ],\n \"additional_data\": {\n \"key_0\": \"string\",\n \"key_1\": 9939,\n \"key_2\": true,\n \"key_3\": 3141\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6f6b572-cb64-4d98-bad3-dc0b535bf9ff", "name": "Превышен rate limit (см. `x-rateLimit`)", "originalRequest": { "url": { "path": [ "api", "widgets", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"action\": \"widget_click\",\n \"widget_id\": \"\",\n \"widget_ids\": [\n \"\",\n \"\"\n ],\n \"additional_data\": {\n \"key_0\": \"string\",\n \"key_1\": 9939,\n \"key_2\": true,\n \"key_3\": 3141\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Секунд до сброса счётчика", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "identify", "description": "", "item": [ { "id": "e1c878ee-c14e-46e5-9423-e66842c9882b", "name": "Связать fingerprint посетителя с известным пользователем", "request": { "name": "Связать fingerprint посетителя с известным пользователем", "description": { "content": "Аналог `_nf('identify', {user_id, email, ...})`. Если анонимный\nконтакт с этим fingerprint'ом существовал — мерджится с\nизвестным контактом по `external_user_id`. Возвращает\nрезультирующий Contact.\n\n**Идемпотентно:** повторный вызов с теми же данными — update.\n", "type": "text/plain" }, "url": { "path": [ "api", "widgets", "identify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"external_user_id\": \"\",\n \"traits\": {\n \"key_0\": 5683.207525794879,\n \"key_1\": 2789.3199224230393\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "376170c3-ae81-4068-837a-f0fade8305cf", "name": "Контакт связан / обновлён", "originalRequest": { "url": { "path": [ "api", "widgets", "identify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"external_user_id\": \"\",\n \"traits\": {\n \"key_0\": 5683.207525794879,\n \"key_1\": 2789.3199224230393\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contact\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"avatar_url\": \"\",\n \"role\": \"user\",\n \"company\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"name\": \"\"\n },\n \"custom_properties\": {\n \"key_0\": 3819,\n \"key_1\": \"string\"\n },\n \"system_properties\": {\n \"key_0\": 5217.043797657918\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"devices\": [\n {\n \"fingerprint\": \"\",\n \"device_type\": \"tablet\",\n \"last_seen_at\": \"\"\n },\n {\n \"fingerprint\": \"\",\n \"device_type\": \"tablet\",\n \"last_seen_at\": \"\"\n }\n ],\n \"first_seen_at\": \"\",\n \"last_seen_at\": \"\",\n \"sessions_count\": \"\",\n \"created_at\": \"\"\n },\n \"merged\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0b706de-017e-4e73-9ba1-4691e1c4f6ab", "name": "Отсутствует или некорректный API-ключ", "originalRequest": { "url": { "path": [ "api", "widgets", "identify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"external_user_id\": \"\",\n \"traits\": {\n \"key_0\": 5683.207525794879,\n \"key_1\": 2789.3199224230393\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1f94ba5-27f9-473e-8402-32e672c788a6", "name": "Ключ не найден или подписка неактивна", "originalRequest": { "url": { "path": [ "api", "widgets", "identify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"external_user_id\": \"\",\n \"traits\": {\n \"key_0\": 5683.207525794879,\n \"key_1\": 2789.3199224230393\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fcf9ecf-0b6d-489c-a8fc-9b9593f1fb26", "name": "Ошибка валидации полей запроса", "originalRequest": { "url": { "path": [ "api", "widgets", "identify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"external_user_id\": \"\",\n \"traits\": {\n \"key_0\": 5683.207525794879,\n \"key_1\": 2789.3199224230393\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ec9653e-d1aa-483e-a808-138bb0919d31", "name": "Превышен rate limit (см. `x-rateLimit`)", "originalRequest": { "url": { "path": [ "api", "widgets", "identify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"external_user_id\": \"\",\n \"traits\": {\n \"key_0\": 5683.207525794879,\n \"key_1\": 2789.3199224230393\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Секунд до сброса счётчика", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "group", "description": "", "item": [ { "id": "81ce0c3f-d521-43ce-8996-0c24af82ec9e", "name": "Связать контакт с компанией (B2B)", "request": { "name": "Связать контакт с компанией (B2B)", "description": { "content": "Аналог `_nf('group', {company_id, name, plan})`. Привязывает\nтекущий контакт (по fingerprint'у) к компании. Компания создаётся\nили обновляется upsert'ом по `external_id`.\n", "type": "text/plain" }, "url": { "path": [ "api", "widgets", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"company_id\": \"\",\n \"traits\": {\n \"key_0\": false,\n \"key_1\": 5753\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2fc24d73-f76c-4c5a-b662-f529fe0e1c85", "name": "OK", "originalRequest": { "url": { "path": [ "api", "widgets", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"company_id\": \"\",\n \"traits\": {\n \"key_0\": false,\n \"key_1\": 5753\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"company\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"user_id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"plan\": \"\",\n \"custom_properties\": {\n \"key_0\": 3021.5914250304977,\n \"key_1\": 3151\n },\n \"contacts_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8c3723f-999c-4ea9-b2a5-b9937d0c681d", "name": "Отсутствует или некорректный API-ключ", "originalRequest": { "url": { "path": [ "api", "widgets", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"company_id\": \"\",\n \"traits\": {\n \"key_0\": false,\n \"key_1\": 5753\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea39f039-4f6a-4c3d-9d73-6a88de5f4bad", "name": "Ключ не найден или подписка неактивна", "originalRequest": { "url": { "path": [ "api", "widgets", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"company_id\": \"\",\n \"traits\": {\n \"key_0\": false,\n \"key_1\": 5753\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ed4198b-d285-4c4c-b23c-ba64ae4a4e71", "name": "Ошибка валидации полей запроса", "originalRequest": { "url": { "path": [ "api", "widgets", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"company_id\": \"\",\n \"traits\": {\n \"key_0\": false,\n \"key_1\": 5753\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad98ee6d-97a3-4e5a-a6d1-11028432d384", "name": "Превышен rate limit (см. `x-rateLimit`)", "originalRequest": { "url": { "path": [ "api", "widgets", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"company_id\": \"\",\n \"traits\": {\n \"key_0\": false,\n \"key_1\": 5753\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Секунд до сброса счётчика", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "reset", "description": "", "item": [ { "id": "1040d63f-25e2-4fec-a707-6fc440fc02e1", "name": "Сбросить идентификацию посетителя (logout)", "request": { "name": "Сбросить идентификацию посетителя (logout)", "description": { "content": "Отвязывает fingerprint от контакта. Используется при logout юзера\nна клиентском сайте, чтобы следующая сессия того же браузера\nначиналась как анонимная.\n\nПосле вызова клиент должен также очистить cookie\n`notiflow_visitor_id` и `sessionStorage`.\n", "type": "text/plain" }, "url": { "path": [ "api", "widgets", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5e202aa8-1c4a-43f0-86f1-c404b09110f8", "name": "OK", "originalRequest": { "url": { "path": [ "api", "widgets", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc90c61d-8ab2-4224-bcda-9879cc98a69d", "name": "Отсутствует или некорректный API-ключ", "originalRequest": { "url": { "path": [ "api", "widgets", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99288063-b2bd-4a4d-b03b-283bf1a74a5a", "name": "Ключ не найден или подписка неактивна", "originalRequest": { "url": { "path": [ "api", "widgets", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2e6a2d7-6254-407b-98bf-8c728217dbe9", "name": "Ошибка валидации полей запроса", "originalRequest": { "url": { "path": [ "api", "widgets", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "845eb195-ddf7-47f1-8199-7da1cfe1fb99", "name": "Превышен rate limit (см. `x-rateLimit`)", "originalRequest": { "url": { "path": [ "api", "widgets", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Секунд до сброса счётчика", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "v1", "description": "", "item": [ { "name": "contacts", "description": "", "item": [ { "id": "218110aa-9a50-4876-92d4-4fd1684727ba", "name": "Создать или обновить контакт", "request": { "name": "Создать или обновить контакт", "description": { "content": "Upsert по `external_id` в рамках вашего аккаунта. Поля `email`,\n`name`, `phone`, `avatar_url` — PII, шифруются в базе. `custom_properties`\nсливается с существующим (не перезаписывает). `tags` добавляются\nчерез `firstOrCreate` — дубликатов не будет.\n\nЕсли передан `company_external_id` — контакт привязывается к\nсуществующей компании (компания не создаётся автоматически;\nиспользуйте сначала `POST /v1/companies`).\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"avatar_url\": \"\",\n \"role\": \"user\",\n \"company_external_id\": \"\",\n \"custom_properties\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "69dcfbe0-561f-4501-abba-a2e7472b20ff", "name": "Контакт обновлён", "originalRequest": { "url": { "path": [ "api", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"avatar_url\": \"\",\n \"role\": \"user\",\n \"company_external_id\": \"\",\n \"custom_properties\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contact\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"avatar_url\": \"\",\n \"role\": \"visitor\",\n \"company\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"name\": \"\"\n },\n \"custom_properties\": {\n \"key_0\": 479.85558656312935,\n \"key_1\": false\n },\n \"system_properties\": {\n \"key_0\": false\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"devices\": [\n {\n \"fingerprint\": \"\",\n \"device_type\": \"tablet\",\n \"last_seen_at\": \"\"\n },\n {\n \"fingerprint\": \"\",\n \"device_type\": \"mobile\",\n \"last_seen_at\": \"\"\n }\n ],\n \"first_seen_at\": \"\",\n \"last_seen_at\": \"\",\n \"sessions_count\": \"\",\n \"created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db9dfec1-2ec6-4ac6-97a6-026e45193013", "name": "Контакт создан", "originalRequest": { "url": { "path": [ "api", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"avatar_url\": \"\",\n \"role\": \"user\",\n \"company_external_id\": \"\",\n \"custom_properties\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contact\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"avatar_url\": \"\",\n \"role\": \"visitor\",\n \"company\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"name\": \"\"\n },\n \"custom_properties\": {\n \"key_0\": 479.85558656312935,\n \"key_1\": false\n },\n \"system_properties\": {\n \"key_0\": false\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"devices\": [\n {\n \"fingerprint\": \"\",\n \"device_type\": \"tablet\",\n \"last_seen_at\": \"\"\n },\n {\n \"fingerprint\": \"\",\n \"device_type\": \"mobile\",\n \"last_seen_at\": \"\"\n }\n ],\n \"first_seen_at\": \"\",\n \"last_seen_at\": \"\",\n \"sessions_count\": \"\",\n \"created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dc1eac8-e0d4-4a32-8a23-7fc40cde2100", "name": "Ключ не найден или подписка неактивна", "originalRequest": { "url": { "path": [ "api", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"avatar_url\": \"\",\n \"role\": \"user\",\n \"company_external_id\": \"\",\n \"custom_properties\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7de61d45-3f68-4133-a5c9-ffe8762079c1", "name": "Ошибка валидации полей запроса", "originalRequest": { "url": { "path": [ "api", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"avatar_url\": \"\",\n \"role\": \"user\",\n \"company_external_id\": \"\",\n \"custom_properties\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4b414bb-b0ff-495e-8d93-0727757f567b", "name": "Превышен rate limit (см. `x-rateLimit`)", "originalRequest": { "url": { "path": [ "api", "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"avatar_url\": \"\",\n \"role\": \"user\",\n \"company_external_id\": \"\",\n \"custom_properties\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Секунд до сброса счётчика", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{externalId}", "description": "", "item": [ { "id": "9d71aaf6-80e3-4d22-97e9-be08ba94ef8d", "name": "Получить контакт по external_id", "request": { "name": "Получить контакт по external_id", "description": {}, "url": { "path": [ "api", "v1", "contacts", ":externalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "externalId", "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cb006ff9-a729-4f4a-b48c-a41c5e7c14ef", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contact\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"avatar_url\": \"\",\n \"role\": \"visitor\",\n \"company\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"name\": \"\"\n },\n \"custom_properties\": {\n \"key_0\": 479.85558656312935,\n \"key_1\": false\n },\n \"system_properties\": {\n \"key_0\": false\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"devices\": [\n {\n \"fingerprint\": \"\",\n \"device_type\": \"tablet\",\n \"last_seen_at\": \"\"\n },\n {\n \"fingerprint\": \"\",\n \"device_type\": \"mobile\",\n \"last_seen_at\": \"\"\n }\n ],\n \"first_seen_at\": \"\",\n \"last_seen_at\": \"\",\n \"sessions_count\": \"\",\n \"created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "396c7659-3d7e-4ed3-b646-a129ab2d775f", "name": "Ключ не найден или подписка неактивна", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb288cb3-80d5-4974-bf19-3248647ef824", "name": "Контакт / компания с таким external_id не найдены", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "314bdba2-6c5a-4396-ab75-2ad02c922b89", "name": "Превышен rate limit (см. `x-rateLimit`)", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Секунд до сброса счётчика", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb0b7eec-3f86-4a5f-91a8-c35034417ea2", "name": "Удалить контакт (GDPR / 152-ФЗ)", "request": { "name": "Удалить контакт (GDPR / 152-ФЗ)", "description": { "content": "Полное каскадное удаление контакта и связанных данных. Обычно\nвызывается по запросу субъекта ПДн на удаление. Операция\n**необратима** — в интерактивном Try It отключена.\n\nЧто удаляется/анонимизируется:\n- запись `contacts`\n- все `contact_devices` (fingerprints)\n- все `contact_tags`\n- в `product_logs` — contact_id обнуляется, fingerprint заменяется на `\"deleted\"`\n- счётчик контактов в компании декрементируется\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "contacts", ":externalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "externalId", "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "b83be870-cfcd-4174-8ce5-8b4a3fd4ace1", "name": "Удалён", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25e9143c-f709-4b09-a594-6664786ddfcc", "name": "Ключ не найден или подписка неактивна", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9bab152-e236-4f34-bb5e-36e80108cb28", "name": "Контакт / компания с таким external_id не найдены", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beabf6e7-1add-4339-a682-0dd6c1b5b93a", "name": "Превышен rate limit (см. `x-rateLimit`)", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Секунд до сброса счётчика", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "tags", "description": "", "item": [ { "id": "743cd9fb-2c02-4bdd-b384-71d1a1ec8d14", "name": "Добавить теги контакту", "request": { "name": "Добавить теги контакту", "description": { "content": "Теги добавляются идемпотентно (дубликаты игнорируются). Возвращает\nактуальный список всех тегов контакта после операции.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "contacts", ":externalId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "externalId", "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "98e2a312-2a70-4c89-98e9-7394ce951124", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be66f1e4-e421-47b0-b9eb-dc3882627996", "name": "Ключ не найден или подписка неактивна", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8241bb6-e480-49c5-a0d4-8258ae64993e", "name": "Контакт / компания с таким external_id не найдены", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a636fc8d-6d29-4b5c-8c2e-608e308cf5ef", "name": "Ошибка валидации полей запроса", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2879dbb8-33ba-40c1-9aa3-28cd5eaf63a6", "name": "Превышен rate limit (см. `x-rateLimit`)", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Секунд до сброса счётчика", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{tag}", "description": "", "item": [ { "id": "1e996ff6-61aa-423e-a0e6-1a9965771391", "name": "Удалить один тег у контакта", "request": { "name": "Удалить один тег у контакта", "description": {}, "url": { "path": [ "api", "v1", "contacts", ":externalId", "tags", ":tag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "externalId", "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" } }, { "type": "any", "value": "", "key": "tag", "disabled": false, "description": { "content": "(Required) Имя тега.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "5b06ff92-334c-42bb-bde4-10e821a9762f", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId", "tags", ":tag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" }, { "disabled": false, "description": { "content": "(Required) Имя тега.", "type": "text/plain" }, "type": "any", "value": "", "key": "tag" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e2ef9e0-e1e5-42ad-954a-c496a8bad586", "name": "Ключ не найден или подписка неактивна", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId", "tags", ":tag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" }, { "disabled": false, "description": { "content": "(Required) Имя тега.", "type": "text/plain" }, "type": "any", "value": "", "key": "tag" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "438c00e5-3c20-4cf7-8b2c-f2781f3b8878", "name": "Контакт / компания с таким external_id не найдены", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId", "tags", ":tag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" }, { "disabled": false, "description": { "content": "(Required) Имя тега.", "type": "text/plain" }, "type": "any", "value": "", "key": "tag" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "844d5674-ed02-4ff6-8a9a-7b2518f617d2", "name": "Превышен rate limit (см. `x-rateLimit`)", "originalRequest": { "url": { "path": [ "api", "v1", "contacts", ":externalId", "tags", ":tag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Внешний идентификатор контакта (ваш `user_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "externalId" }, { "disabled": false, "description": { "content": "(Required) Имя тега.", "type": "text/plain" }, "type": "any", "value": "", "key": "tag" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Секунд до сброса счётчика", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "companies", "description": "", "item": [ { "id": "58b1890f-77f4-4513-8126-af39ec845aed", "name": "Создать или обновить компанию", "request": { "name": "Создать или обновить компанию", "description": { "content": "Upsert по `external_id`. `custom_properties` мерджится с\nсуществующим (не перезаписывает).\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"plan\": \"\",\n \"custom_properties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d8777c4b-44d7-4170-ba0c-bda507ef9d27", "name": "Компания обновлена", "originalRequest": { "url": { "path": [ "api", "v1", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"plan\": \"\",\n \"custom_properties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"company\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"user_id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"plan\": \"\",\n \"custom_properties\": {\n \"key_0\": 3021.5914250304977,\n \"key_1\": 3151\n },\n \"contacts_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d79d4d52-5cee-4235-ae1b-c0de566238b7", "name": "Компания создана", "originalRequest": { "url": { "path": [ "api", "v1", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"plan\": \"\",\n \"custom_properties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"company\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"user_id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"plan\": \"\",\n \"custom_properties\": {\n \"key_0\": 3021.5914250304977,\n \"key_1\": 3151\n },\n \"contacts_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b049b94e-474b-4c2c-829e-3badb9fda5eb", "name": "Ключ не найден или подписка неактивна", "originalRequest": { "url": { "path": [ "api", "v1", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"plan\": \"\",\n \"custom_properties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb564927-9c3b-4ebb-9a50-9afbccfb6b94", "name": "Ошибка валидации полей запроса", "originalRequest": { "url": { "path": [ "api", "v1", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"plan\": \"\",\n \"custom_properties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e6de9e2-328e-4f38-896b-2f5ebb78ac68", "name": "Превышен rate limit (см. `x-rateLimit`)", "originalRequest": { "url": { "path": [ "api", "v1", "companies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"plan\": \"\",\n \"custom_properties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Секунд до сброса счётчика", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "events", "description": "", "item": [ { "id": "b71e985b-31f3-4edc-9f55-e3bef103274d", "name": "Трекать событие на стороне сервера", "request": { "name": "Трекать событие на стороне сервера", "description": { "content": "Server-side событие для контакта. Используйте когда действие\nпроизошло не в браузере — например, оплата через платёжную систему\n(завершение транзакции), создание заказа в админке, signup через\nSSO, отказ в заявке и т.п.\n\n`action` — произвольная строка-идентификатор события (напр.\n`purchase_completed`, `order_created`, `subscription_upgraded`).\n`metadata` — любой JSON-объект с деталями.\n\n**Идемпотентно:** событие создаётся на каждый вызов (append-only\nлог). Если нужна дедупликация — передавайте `metadata.order_id`\nили аналогичный ключ и проверяйте на своей стороне.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_external_id\": \"\",\n \"action\": \"\",\n \"metadata\": {\n \"key_0\": 1283,\n \"key_1\": 7749.663803844555,\n \"key_2\": 3069.120624878776,\n \"key_3\": true,\n \"key_4\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "de661d74-d26c-4ec1-a5b4-5b00f30dd181", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_external_id\": \"\",\n \"action\": \"\",\n \"metadata\": {\n \"key_0\": 1283,\n \"key_1\": 7749.663803844555,\n \"key_2\": 3069.120624878776,\n \"key_3\": true,\n \"key_4\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16f2a2e0-532a-4a6e-b1ba-e035bb021061", "name": "Ключ не найден или подписка неактивна", "originalRequest": { "url": { "path": [ "api", "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_external_id\": \"\",\n \"action\": \"\",\n \"metadata\": {\n \"key_0\": 1283,\n \"key_1\": 7749.663803844555,\n \"key_2\": 3069.120624878776,\n \"key_3\": true,\n \"key_4\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62a54cab-34f3-43e1-9601-2790dad5b343", "name": "Контакт с таким external_id не найден. Создайте его сначала через POST /v1/contacts.", "originalRequest": { "url": { "path": [ "api", "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_external_id\": \"\",\n \"action\": \"\",\n \"metadata\": {\n \"key_0\": 1283,\n \"key_1\": 7749.663803844555,\n \"key_2\": 3069.120624878776,\n \"key_3\": true,\n \"key_4\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc282f8b-3ca1-4c8c-8ea9-f346ac4ebca0", "name": "Ошибка валидации полей запроса", "originalRequest": { "url": { "path": [ "api", "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_external_id\": \"\",\n \"action\": \"\",\n \"metadata\": {\n \"key_0\": 1283,\n \"key_1\": 7749.663803844555,\n \"key_2\": 3069.120624878776,\n \"key_3\": true,\n \"key_4\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2e003f0-ba47-480e-800c-b68d7fa009fd", "name": "Превышен rate limit (см. `x-rateLimit`)", "originalRequest": { "url": { "path": [ "api", "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_external_id\": \"\",\n \"action\": \"\",\n \"metadata\": {\n \"key_0\": 1283,\n \"key_1\": 7749.663803844555,\n \"key_2\": 3069.120624878776,\n \"key_3\": true,\n \"key_4\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Секунд до сброса счётчика", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "integrations", "description": "", "item": [ { "name": "visitors", "description": "", "item": [ { "id": "298f43d0-0c9d-4629-acb0-81cfc61dc49a", "name": "Список визитёров / контактов", "request": { "name": "Список визитёров / контактов", "description": { "content": "Читает контакты вашего аккаунта с базовыми полями. Используется\nдля зеркалирования в CRM или BI. Для полной информации по\nконкретному контакту используйте `GET /v1/contacts/{externalId}`.\n\nДля постраничной выгрузки полной базы используйте тот же\nendpoint — пагинация стандартная Laravel (`page` / `per_page`).\n", "type": "text/plain" }, "url": { "path": [ "api", "integrations", "visitors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cb83cf2f-5d03-4fad-9b78-d2e7ed34cecc", "name": "OK", "originalRequest": { "url": { "path": [ "api", "integrations", "visitors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"external_id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"avatar_url\": \"\",\n \"role\": \"lead\",\n \"company\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"name\": \"\"\n },\n \"custom_properties\": {\n \"key_0\": 4578.262748132477,\n \"key_1\": \"string\",\n \"key_2\": true,\n \"key_3\": 7066.943002928569\n },\n \"system_properties\": {\n \"key_0\": 7409.993922942638,\n \"key_1\": 3060.310578151475\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"devices\": [\n {\n \"fingerprint\": \"\",\n \"device_type\": \"mobile\",\n \"last_seen_at\": \"\"\n },\n {\n \"fingerprint\": \"\",\n \"device_type\": \"desktop\",\n \"last_seen_at\": \"\"\n }\n ],\n \"first_seen_at\": \"\",\n \"last_seen_at\": \"\",\n \"sessions_count\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"external_id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"avatar_url\": \"\",\n \"role\": \"visitor\",\n \"company\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"name\": \"\"\n },\n \"custom_properties\": {\n \"key_0\": false,\n \"key_1\": 548.9345660400191,\n \"key_2\": true\n },\n \"system_properties\": {\n \"key_0\": 9173.19339802353\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"devices\": [\n {\n \"fingerprint\": \"\",\n \"device_type\": \"tablet\",\n \"last_seen_at\": \"\"\n },\n {\n \"fingerprint\": \"\",\n \"device_type\": \"tablet\",\n \"last_seen_at\": \"\"\n }\n ],\n \"first_seen_at\": \"\",\n \"last_seen_at\": \"\",\n \"sessions_count\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": \"\",\n \"per_page\": \"\",\n \"current_page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78a7eabd-0141-4a20-831c-d40cf7959caf", "name": "Ключ не найден или подписка неактивна", "originalRequest": { "url": { "path": [ "api", "integrations", "visitors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a77cb40a-ec8b-470a-8231-284281cc2626", "name": "Превышен rate limit (см. `x-rateLimit`)", "originalRequest": { "url": { "path": [ "api", "integrations", "visitors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Секунд до сброса счётчика", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{fingerprint}", "description": "", "item": [ { "id": "b4147f90-dcc1-4b08-91ab-8a435161ec69", "name": "Детали визитёра по fingerprint", "request": { "name": "Детали визитёра по fingerprint", "description": {}, "url": { "path": [ "api", "integrations", "visitors", ":fingerprint" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "fingerprint", "disabled": false, "description": { "content": "(Required) Browser fingerprint посетителя (UUID из cookie `notiflow_visitor_id`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "550c9972-cc8c-49ff-9f5c-2b04deb786d5", "name": "OK", "originalRequest": { "url": { "path": [ "api", "integrations", "visitors", ":fingerprint" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Browser fingerprint посетителя (UUID из cookie `notiflow_visitor_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fingerprint" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"avatar_url\": \"\",\n \"role\": \"lead\",\n \"company\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"name\": \"\"\n },\n \"custom_properties\": {\n \"key_0\": 7362.78929956705\n },\n \"system_properties\": {\n \"key_0\": 6092.399068223057,\n \"key_1\": 720,\n \"key_2\": 4393.142027125218\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"devices\": [\n {\n \"fingerprint\": \"\",\n \"device_type\": \"tablet\",\n \"last_seen_at\": \"\"\n },\n {\n \"fingerprint\": \"\",\n \"device_type\": null,\n \"last_seen_at\": \"\"\n }\n ],\n \"first_seen_at\": \"\",\n \"last_seen_at\": \"\",\n \"sessions_count\": \"\",\n \"created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40c8552b-e47c-4d2e-9c86-75ccad419835", "name": "Ключ не найден или подписка неактивна", "originalRequest": { "url": { "path": [ "api", "integrations", "visitors", ":fingerprint" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Browser fingerprint посетителя (UUID из cookie `notiflow_visitor_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fingerprint" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67559a66-a4d1-4892-a72f-23426affd15d", "name": "Контакт / компания с таким external_id не найдены", "originalRequest": { "url": { "path": [ "api", "integrations", "visitors", ":fingerprint" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Browser fingerprint посетителя (UUID из cookie `notiflow_visitor_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fingerprint" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f12553d8-d0a9-422e-ad50-ede00ad95be6", "name": "Превышен rate limit (см. `x-rateLimit`)", "originalRequest": { "url": { "path": [ "api", "integrations", "visitors", ":fingerprint" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Browser fingerprint посетителя (UUID из cookie `notiflow_visitor_id`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fingerprint" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Секунд до сброса счётчика", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ], "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "X-Api-Key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://cp.notiflow.ru" } ], "info": { "_postman_id": "b5df4574-675d-489b-b5cc-9b92d6d3f43c", "name": "Notiflow Integration API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Публичное API Notiflow для интеграций. Три основные группы эндпоинтов:\n\n1. **Widget SDK** — клиентский JavaScript-виджет (`_nf`) и HTTP-эндпоинты,\n которые он обслуживает. Используйте, если встраиваете виджет на свой сайт.\n2. **Server REST API v1** — сервер-сервер. Импортируйте контакты,\n компании и события из своей системы в Notiflow.\n3. **Integrations REST** — чтение списка посетителей/контактов для\n зеркалирования в свою CRM/BI.\n\nОтдельно публикуется каталог **исходящих webhook-событий** — мы шлём\nподписанные HMAC-SHA256 POST'ы на ваш endpoint при новых чатах, сменах\nlead-score tier'а, автоответах AI и пр. Контракт webhook'ов описан на\n`https://notiflow.ru/docs/webhooks`.\n\n**Rate limits:** указаны на каждом endpoint'е в блоке `x-rateLimit`.\nПри превышении — HTTP 429 с заголовком `Retry-After`.\n\n**Аутентификация:** все серверные запросы — через заголовок\n`X-Api-Key`. Ключ получаете в кабинете в разделе API-ключи. Для\nклиентских виджет-запросов тот же ключ передаётся прозрачно SDK.\n\n\nContact Support:\n Name: Notiflow Support\n Email: mail@notiflow.ru", "type": "text/plain" } } }