◆ Sapport для разработчиков Справочник API Каталог ошибок OpenAPI
Разделы

#Ячейки и данные

Статус: Доступно. Ячейки, их границы данных и журнал выдач ПДн; метод GET /disclosures — Планируется.

Назначение: какие бывают ячейки, на какой адрес слать запросы, что значит «ключ одной ячейки», как распределены обязанности по персональным данным.

#Три ячейки

Платформа работает тремя независимыми боевыми ячейками. У каждой отдельные серверы, отдельная база, отдельные секреты и своё юридическое лицо. Данные одной ячейки не видны в другой.

ЯчейкаБренд / доменБазовый адрес APIЯзыки страниц
RUФормула крема — formula-cream.prohttps://formula-cream.pro/api/public/v1русский
ENWalker Formulation Academy — wfacademy.orghttps://wfacademy.org/api/public/v1английский, русский
IDwfacademy.idhttps://wfacademy.id/api/public/v1индонезийский, английский, русский

Ячейка, в которой вы зарегистрированы, определяет:

Язык страницы — не ячейка. Сайт ячейки ID отдаёт страницы и по-индонезийски, и по-английски, и по-русски. Не определяйте ячейку по языку: используйте адрес, на котором вы входите в кабинет, либо префикс своего ключа.

#Ключ одной ячейки

Ключ действует только на адресе той ячейки, где выпущен. Префикс показывает ячейку:

ПрефиксЯчейка
sap_ru_…RU
sap_en_…EN
sap_id_…ID

Ключ нельзя перенести в другую ячейку. Если у вас есть аккаунты в нескольких ячейках, это независимые аккаунты: в каждой ячейке свои интеграции и свои ключи.

#Ошибка wrong_cell

Если вызвать API ячейки EN ключом RU, вернётся:

HTTP/1.1 401 Unauthorized
Content-Type: application/problem+json
X-Request-Id: req_EXAMPLE0002
{
  "type": "https://wfacademy.org/developers/errors#wrong_cell",
  "title": "Ключ принадлежит другой ячейке",
  "status": 401,
  "code": "wrong_cell",
  "detail": "Этот ключ выпущен в другой ячейке. Используйте адрес из поля correct_base_url.",
  "correct_base_url": "https://formula-cream.pro/api/public/v1",
  "request_id": "req_EXAMPLE0002"
}

Что делать: взять адрес из поля correct_base_url и исправить базовый адрес в конфигурации. Если вы обслуживаете арендаторов нескольких ячеек, храните пары «ключ — базовый адрес» вместе и выводите адрес из префикса ключа (sap_<ячейка>_…).

#Хранение данных и ответственность

ВопросОтвет
Кто оператор ПДнАрендатор. Он определяет цели и основания обработки ПДн своих клиентов.
Кто мыОбработчик по поручению арендатора.
Где данные RUВ России. Из ячейки RU персональные данные трансгранично не передаются.
Где данные EN и IDВ своей ячейке, на своей базе.
Можно ли получить данные другой ячейкиНет. Запросы всегда идут в ячейку ключа.

#ПДн в ячейке RU

Ограничение ключа одной ячейкой гарантирует, что платформа хранит данные RU в России. Оно не мешает вам получить данные запросом с российского адреса и переслать их за рубеж: с момента выдачи ответственность за соблюдение закона об ПДн несёт арендатор как оператор.

Точки API с ПДн (диалоги, сообщения, лиды, контакты) открыты на всех ячейках. В ячейке RU для областей с ПДн (conversations:*, leads:*) действуют дополнительные условия:

УсловиеКак выполняется
Список разрешённых IPОбязателен для интеграции: ключ с такими областями без списка не выпускается
Страна размещения принимающей системыУказывается при подключении интеграции; допускается только РФ
Основание передачиУказывается при подключении интеграции
Запрет трансграничной передачиЕсли страна размещения не РФ, области conversations:*, leads:* и флаг include_pii для этой интеграции не выдаются: ответ 403 pii_transfer_not_allowed
Журнал раскрытий и журнал выдачВедутся автоматически, см. ниже

#Передача ПДн во внешние системы

Подключение внешней CRM или вебхука с include_pii: true — это передача ПДн третьему лицу по решению арендатора. Для неё:

Подробно — Передача ПДн.

#Журнал выдач ПДн

Каждая выдача ПДн через API (ответ с контактом, событие с include_pii: true) фиксируется строкой журнала: кто (интеграция и ключ), что (тип данных), сколько записей. Сами значения в журнал не пишутся.

Журнал виден арендатору в кабинете и по GET /disclosures (Планируется; курсорный список, Соглашения). Хранится 3 года.

#Что платформа делает с ПДн по умолчанию

#Сроки хранения служебных данных

ДанныеСрок
Журнал запросов API (без тел и ПДн)90 суток
Журнал доставок вебхуков30 суток
Журнал выдач ПДн и журнал раскрытий3 года
Кэш идемпотентности24 часа
Курсор списка24 часа
Надгробия удалённых записей (include_deleted)30 суток
Хиты трекера (в аналитике)180 суток

Сроки хранения самих диалогов, лидов и контактов определяются настройками арендатора и договором.

#Что отличается между ячейками

ЧтоПоведение
Базовый адрес и ключисвои у каждой ячейки
Валюта денег и кошелькаRUB, GBP, IDR
Состав языковсм. таблицу выше
Серверный маяк модулей по умолчаниюRU — полный; EN и ID — анонимный
ПДн-точки APIоткрыты на всех ячейках; обязательный список IP, страна и основание передачи, а также запрет передачи получателям вне РФ — только для RU

Форма запросов, ошибок и вебхуков одинакова во всех ячейках. Различаются только адреса, валюты и условия по ПДн.

#Заметки