Client agreement

prepare text

Подготовка текста с согласием .request

POST /api/v2/clients/1000000224/agreements/prepare-text HTTP/1.1

{
  "agreementType" : "PERSONAL_DATA_PROCESSING"
}
Table 147. /api/v2/clients/{clientId}/agreements/prepare-text
Parameter Description

clientId

Id клиента
Path Type Description Constraints

agreementType

String

Тип согласия [PERSONAL_DATA_PROCESSING, ALCON_PURCHASES]

check agreement

Проверка согласия на обработку персональных данных
true - клиент имеет активное согласие
false - согласия нет или оно отозвано
request
GET /api/v2/clients/1000000224/agreements/active?clientAgreementType=PERSONAL_DATA_PROCESSING HTTP/1.1
Table 148. /api/v2/clients/{clientId}/agreements/active
Parameter Description

clientId

Id клиента
Parameter Description

clientAgreementType

[PERSONAL_DATA_PROCESSING, ALCON_PURCHASES]
response
HTTP/1.1 200 OK

"ACCEPTED"

necessity

Проверка на необходимость сбора согласия для оформленного заказа
request
GET /api/v2/clients/agreements/necessity?clientAgreementType=ALCON_PURCHASES&orderIds=8999888777 HTTP/1.1
Table 149. request description
Parameter Description

orderIds

id оформленных заказов

clientAgreementType

[PERSONAL_DATA_PROCESSING, ALCON_PURCHASES]
response
HTTP/1.1 200 OK

{
  "clientId" : 1000000224,
  "necessity" : true
}
Path Type Description

clientId

Number

Id клиента

necessity

Boolean

true - требуется согласие

get agreement

Согласие на обработку персональных данных в виде html
request
GET /api/v2/clients/1000000224/agreements?clientAgreementType=PERSONAL_DATA_PROCESSING HTTP/1.1
Table 150. /api/v2/clients/{clientId}/agreements
Parameter Description

clientId

clientId
Parameter Description

clientAgreementType

[PERSONAL_DATA_PROCESSING, ALCON_PURCHASES]

Проверка было ли отправлено сообщение с согласием ранее

request
GET /api/v2/clients/1000000224/agreements/is-message-sent HTTP/1.1
Table 151. /api/v2/clients/{clientId}/agreements/is-message-sent
Parameter Description

clientId

Id клиента
response
HTTP/1.1 200 OK

true

send message

Каскадная рассылка сообщений с кодом подтверждения
request
POST /api/v2/clients/1000000224/agreements/message HTTP/1.1

{
  "phoneNumber" : "89999999999",
  "email" : null,
  "updateEmail" : false,
  "agreementType" : "PERSONAL_DATA_PROCESSING",
  "collectionMethod" : "VK"
}
Table 152. /api/v2/clients/{clientId}/agreements/message
Parameter Description

clientId

Id клиента
Path Type Description Constraints

phoneNumber

String

Номер телефона клиента

email

String

Email клиента, если метод сбора EMAIL

Must be a well-formed email address

agreementType

String

Тип согласия [PERSONAL_DATA_PROCESSING, ALCON_PURCHASES]

Must not be null

collectionMethod

String

Метод сбора [SMS, QUESTIONNAIRE, VK, EMAIL]

Must not be null
response
HTTP/1.1 200 OK

accept agreement

Создание согласия. Требуется ранее отосланное сообщение клиенту с кодом подтверждения
Возвращает:
true, если код верный. Сохраняет согласие. Обновляет телефон клиента в базе, если он поменялся
false, если код неверный.
request
POST /api/v2/clients/1000000224/agreements HTTP/1.1

{
  "confirmationCode" : "0737",
  "agreementType" : "ALCON_PURCHASES",
  "collectionMethod" : "SMS",
  "rejection" : false
}
Table 153. /api/v2/clients/{clientId}/agreements
Parameter Description

clientId

Id клиента
Path Type Description Constraints

confirmationCode

String

Код подтверждения, который ввел пользователь

agreementType

String

Тип согласия [PERSONAL_DATA_PROCESSING, ALCON_PURCHASES, N3HEALTH]

Must not be null

collectionMethod

String

Метод сбора согласия [SMS, QUESTIONNAIRE, VK, EMAIL]

Must not be null

rejection

Boolean

true - отказ, false - согласие (только для N3HEALTH)
response
HTTP/1.1 200 OK

true

revoke

Отзыв согласия клиента
request
DELETE /api/v2/clients/1000000224/agreements?clientAgreementType=PERSONAL_DATA_PROCESSING HTTP/1.1
Table 154. /api/v2/clients/{clientId}/agreements
Parameter Description

clientId

Id клиента
Parameter Description

clientAgreementType

[PERSONAL_DATA_PROCESSING, ALCON_PURCHASES]
response
HTTP/1.1 200 OK

← Previous: Contract | ↑ Up: Optima2 API v.2 REST | Next: Department →