Сегментация клиентов через Partner API

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

Для использования функционала сегментации клиентов в Partner API необходимо сначала создать теги в UDS Бизнес по инструкции 

Примеры запросов в Partner API

Получение списка тегов в компании 

Для получение списка тегов в компании нужно отправить GET запрос на url

https://api.uds.app/partner/v2/tags

В  ответ вернется список тегов в компании

{
    "rows": [
    {
        "id": 4400,
        "name": "тег 1"
    },
    {
         "id": 4401,
         "name": "тег 2"
     },
     {
         "id": 4402,
         "name": "тег 3"
     }
    ],
    "total": 3
}

где name - название тега в UDS Бизнес, id - идентификатор тега, который необходимо в дальнейшем передавать для установки этого тега у клиента.

Получение списка тегов у клиента в компании

Если у клиента в компании уже установлены теги, то при получении информации о клиенте в ответ вернется список тегов.

Для получения списка тегов клиента в компании необходимо определить id клиента в компании, который отображается на подробной странице клиента в UDS Бизнес.

или из информации по клиенту из Partner API participant -> id 

и далее отправить GET запрос на url

https://api.uds.app/partner/v2/customers/{id клиента в компании}/tags

В  ответ вернется список тегов у клиента в компании

{
    "rows": [
    {
        "id": 4400,
        "name": "тег 1"
    },
    {
         "id": 4402,
         "name": "тег 3"
    }
    ],
    "total": 3
}

где запрос - название тега в UDS Бизнес, id - идентификатор тега.

Также информация о тегах клиента можно получить, отправив  GET запрос на url

https://api.uds.app/partner/v2/customers/{id клиента в компании>}

или GET запрос c кодом клиента из приложения UDS App, номером телефона или uid на url

https://api.uds.app/partner/v2/customers/find?code={код клиента}&phone={номер телефона}&uid={uid клиента}

В ответ вернется информация со списком тегов у клиента в объекте tags

{
  "phone": "+78007754524",
  "gender": "NOT_SPECIFIED",
  "uid": "bc632537-1111-1111-111-149ab78dd7f7",
  "birthDate": "1999-03-17",
  "channelName": null,
  "tags": [
    {
      "id": 4400,
      "name": "тег 1"
    },
    {
      "id": 4402,
      "name": "тег 3"
    }
  ],
  "email": "support@uds.app",
  "avatar": null,
  "participant": {
    "inviterId": null,
    "discountRate": 0,
    "cashbackRate": 5,
    "dateCreated": "2021-03-18T10:14:23.464Z",
    "points": 3640.32,
    "id": 10995123456,
    "lastTransactionTime": "2022-04-25T08:26:21.056Z",
    "membershipTier": {
      "conditions": {
        "effectiveInvitedCount": null,
        "totalCashSpent": null
      },
      "name": "Новичок",
      "rate": 5,
      "uid": "base"
    }
  },
  "displayName": "Support UDS"
}

Установка и редактирование тегов клиента

Для установки тега клиенту необходимо отправить POST запрос  со списком всех тегов в теле запроса, которые должны быть у клиента, на URL

https://api.uds.app/partner/v2/customers/{id клиента в компании}/tags

Пример запроса:
curl --location --request POST 'https://api.uds.app/partner/v2/customers/{id клиента в компании}/tags' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic NpqTTJaUrTmpZdw==' \

--data-raw '{
    "ids":["4400", "4401", "4402"]
}'

Если необходимо убрать некоторые теги, то при отправки POST запроса необходимо передать список только актуальных тегов. Теги, которые не были переданы в запросе, будут удалены.

Если передать пустой список, то у клиента будут удалены все теги.

Установка тегов клиента при проведении операции

Для установки тегов клиенту при проведении оплаты необходимо при отправке POST запроса с информацией об оплате добавить объект tags со списком тегов, которые должны быть у клиента.

Важно! При использовании метода установки тегов при проведении операции теги у клиента только добавляются, для изменения списка тегов у клиента необходимо использовать метод редактирования тегов или изменить теги у клиента в личном кабинете UDS Бизнес

Пример запроса:
curl --location --request POST 'https://api.uds.app/partner/v2/operations' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic NTQ5NzU1Ok16STFZelZsT1RRdUw==' \
--data-raw '{
"code": 108523,
"participant": {
"uid": null,
"phone": null
},
"nonce": "286f1459-b257-4e6d-b97e-0ba62cfa128e",
"cashier": {
"externalId": "3526367191",
"name": "кассир"
},
"receipt": {
"total": "1000",
"cash": "900",
"points": "100",
"number": 1234554321,
"skipLoyaltyTotal": 200
},

"tags": ["1","2"]

}'