В терминологии SailPlay, Отдел - это любая составная (или логическая) часть вашего бизнеса. Отделом может быть, например, магазин, склад, Отдельная касса, мобильное приложение (как тип), либо часть сайта, либо весь сайт. Соответственно, store_department_id - идентификатор (ID) Отдела партнера в системе SailPlay.
Сотрудник - это единица Отдела, для которой доступны операции: авторизация, совершение покупок/заказов, выдача подарков и т.д. Сотрудник может быть как физическим лицом, так и частью IT-системы. Например, имеет смысл для вашего веб-сайта создать отдельную учетную запись Сотрудника, через которую будут совершаться API-запросы, связанные с действиями ваших клиентов на вашем веб-сайте. Это позволит разделить аналитику в разрезе отдельных Отделов, Подразделений и Сотрудников.
Важно, что у каждого Сотрудника есть свой личный PIN-код, которым он подписывает все транзакции. Каждый Сотрудник может принадлежать одному и только одному Отделу. Если Сотрудник должен иметь возможность проводить транзакции в рамках другого Отдела, его нужно там создать. PIN-коды’ы должны быть уникальными в рамках одного Отдела.
Подразделение - это категория или группа Отделов, объединенная по какому-либо логическому свойству. Каждый Отдел должен быть включен в какое-либо Подразделение.
Вся аналитическая информация записывается в разрезе Отделов и Сотрудников, но при необходимости может быть агрегированна по каким-либо другим свойствам, включая Подразделения или город Отдела.
API для взаимодействия с системой Отделов и Подразделений SailPlay позволяет автоматизировать задачи передачи информации о Сотрудниках в систему или реализовать механизм авторизации в WEB-интерфейсе платформы через какой-либо механизм авторизации, отличный от стандартного, по адресу sailplay.ru.
Для всех запросов обязательными параметрами являются стандартные данные подписи запросов:
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
нет | unit_id | Идентификатор Подразделения. Если не указан - используется Подразделение по умолчанию. |
нет | name | Наименование Отдела. |
нет | kind | Тип Отдела. Может принимать значения site и default для дополнительной отметки о типе Отдела. |
нет | origin_id | Идентификатор Отдела в вашей системе. Используется для взаимодействия с API. |
нет | country | Страна Отдела. |
нет | region_id | Регион Отдела. |
нет | timezone | Часовой пояс. |
нет | business_hours | График работы. |
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
нет | department_id | Внутренний идентификатор Отдела. Используется id отдела, полученный при его создании. |
нет | unit_id | Идентификатор Подразделения. Если не указан - используется Подразделение по умолчанию. |
нет | name | Наименование Отдела. |
нет | kind | Тип Отдела. Может принимать значения site и default для дополнительной отметки о типе Отдела. |
нет | origin_id | Идентификатор Отдела в вашей системе. Используется для взаимодействия с API. |
нет | country | Страна Отдела. |
нет | region_id | Регион Отдела. |
нет | timezone | Часовой пояс. |
нет | business_hours | График работы. |
https://sailplay.ru/api/v2/partners/departments/create/?name=Отдел2&token=c699d95ebbb33a1c35e2f0c8e8a44df3ba55daa7&store_department_id=64&pin_code=6607
{ "status": "ok", "name": "Отдел2", "country": null, "id": 153, "unit_id": 35, "timezone": null, "key": 95547488, "kind": "site", "points_rate": null, "origin_id": null, "region_id": null }
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
нет | dep_id | Идентификатор отключаемого Отдела. |
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
нет | unit_id | Идентификатор Подразделения. Если не указан - отображается полный список Отделов. |
нет | page | Страница списка. |
https://sailplay.ru/api/v2/partners/departments/list/?token=c699d95ebbb33a1c35e2f0c8e8a44df3ba55daa7&store_department_id=64&pin_code=6607
{ "status": "ok", "departments": [ { "id": 64, "timezone": "Asia/Irkutsk", "region_id": 2, "points_rate": null, "name": "default_dep", "origin_id": "" } ] }
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
нет | dep_id | Идентификатор Отдела. |
https://sailplay.ru/api/v2/partners/departments/info/?token=c699d95ebbb33a1c35e2f0c8e8a44df3ba55daa7&store_department_id=64&dep_id=6607
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | name | Название Подразделения. |
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | name | Название категории тегов. |
https://sailplay.ru/api/v2/partners/departments/tags/category/create/?store_department_id=64&pin_code=6607&token=73bbab6a2ca7be013fa182dfb8f88483042cf9cb&name=main
{ "status": "ok", "id": 2, "name": "main" }
При удалении категории удаляются все записи тегов этой категории.
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | dep_id | Идентификатор категории. |
https://sailplay.ru/api/v2/partners/departments/tags/category/delete/?store_department_id=64&pin_code=6607&token=73bbab6a2ca7be013fa182dfb8f88483042cf9cb&dep_id=2
{ "status": "ok", }
Этот метод не требует параметров кроме обязательных. В ответе будет возвращен список идентификаторов и названий тегов.
https://sailplay.ru/api/v2/partners/departments/tags/category/list/?store_department_id=64&pin_code=6607&token=73bbab6a2ca7be013fa182dfb8f88483042cf9cb
{ "status": "ok", "categories": [ { "tags": [ { "id": 2, "name": "tag1" } ], "id": 2, "name": "main" } ] }
Метод создает тег, но не привязывает его к конкретному Отделу.
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | name | Название тега. |
да | tag_id | ID тега. |
да | category_id | Категория, к которой относится тег. |
https://sailplay.ru/api/v2/partners/departments/tags/create/?store_department_id=64&pin_code=6607&token=73bbab6a2ca7be013fa182dfb8f88483042cf9cb&name=tag1&category_id=2
{ "status": "ok", "category_id": 2, "id": 2, "name": "tag1" }
Метод позволяет обновить название или категорию тега.
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | name | Название тега. |
да | tag_id | ID тега. |
да | category_id | Категория, к которой относится тег. |
https://sailplay.ru/api/v2/partners/departments/tags/edit/?store_department_id=64&pin_code=6607&token=73bbab6a2ca7be013fa182dfb8f88483042cf9cb&name=tag1&category_id=2
{ "status": "ok", "category_id": 2, "id": 2, "name": "tag1" }
При удалении тега удаляются все записи этого тега в Отделах.
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | tag_id | ID тега. |
https://sailplay.ru/api/v2/partners/departments/tags/delete/?store_department_id=64&pin_code=6607&token=73bbab6a2ca7be013fa182dfb8f88483042cf9cb&tag_id=2
{ "status": "ok" }
Метод позволяет присвоить Отделу тот или иной тег. Если на момент вызова метода тег еще не создан - будет возращена ошибка.
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | tag_id | ID тега. |
да | dep_id | ID Отдела. |
https://sailplay.ru/api/v2/partners/departments/tags/add/?store_department_id=64&pin_code=6607&token=73bbab6a2ca7be013fa182dfb8f88483042cf9cb&tag_id=2&department_id=64
{ "status": "ok", "created": true }
Метод позволяет присвоить Отделу тот или иной тег. Если на момент вызова метода тег еще не создан - будет возращена ошибка.
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | tag_id | ID тега. |
да | dep_id | ID Отдела. |
https://sailplay.ru/api/v2/partners/departments/tags/remove/?store_department_id=64&pin_code=6607&token=73bbab6a2ca7be013fa182dfb8f88483042cf9cb&tag_id=2&department_id=64
{ "status": "ok" }
Поззволяет получить основную информацию о созданном ранее Сотруднике.
В ответе от сервера содержится информации о принадлежности к Отделам, базовая информация о имени и роли и авторизационный токен (auth_hash).
Авторизационный токен используется для предоставления доступа в WEB-интерфейс из каких-либо других систем.
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | phone | Телефон Сотрудника |
https://sailplay.ru/api/v2/partners/managers/view/?store_department_id=6433&token=cd9b5dcc7477cd2d90733ac24557dfd0592fb463&phone=70003322260
Имя параметра | Описание параметра |
status | |
manager | Объект с вложенными полями: |
name | Имя и Фамилия Сотрудника |
phone | Телефон Сотрудника |
role | Роль Сотрудника |
id | ID Сотрудника в системе SailPlay |
auth_hash | Авторизационный токен Сотрудника. Может быть использован для авторизации в WEB-интерфейсе. |
pin_code | Пин-код Сотрудника |
departments | Массив объектов, содерщаий: |
gifts_points_sum | Количество баллов, списанных Сотрудником на выдачу подарков |
points_sum | Количество баллов, начисленных за покупки, созданных Сотрудником |
department_id | ID Отдела. |
{ "status": "ok", "manager": { "name": "test ", "departments": [{ "gifts_points_sum": 0, "points_sum": "7", "department_id": 6433 }], "phone": "70003322260", "role": "manager", "auth_hash": "3f950471514d61f9b250ae12412a0b6e63734a3876", "id": 82727, "pin_code": "6132" } }
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | position_id | Должность Сотрудника. |
нет | first_name | Имя Сотрудника. |
нет | last_name | Фамилия Сотрудника. |
нет | middle_name | Отчество Сотрудника |
нет | birth_date | День рождения Сотрудника |
нет | department_id | Отдел, к которому привязан Сотрудник. |
нет | sex | Пол (1- мужской, 2 - женский). |
нет | role_id | Набор прав Сотрудника. При создании клиента ему автоматически присваивается роль по умолчанию - без прав и доступа к API. |
https://sailplay.ru/api/v2/partners/employees/create/?department_id=64&position_id=77&origin_id=102&token=c699d95ebbb33a1c35e2f0c8e8a44df3ba55daa7&store_department_id=64&pin_code=6607
{ "status": "ok", "career": [ { "position_id": 77, "id": 6, "end_date": "", "department_id": 64, "start_date": "2015-11-11" } ], "id": 454, "pin_code": null, "last_name": null, "role_id": 5, "department_id": 64, "email": null, "middle_name": null, "first_name": null }
При создании записи Сотрудника автоматически заполняется первая запись в его карьере.
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | position_id | Должность Сотрудника. |
нет | first_name | Имя Сотрудника. |
нет | last_name | Фамилия Сотрудника. |
нет | middle_name | Отчество Сотрудника |
нет | birth_date | День рождения Сотрудника |
нет | department_id | Отдел, к которому привязан Сотрудник. |
нет | sex | Пол (1- мужской, 2 - женский). |
нет | role_id | Набор прав Сотрудника. |
https://sailplay.ru/api/v2/partners/employees/edit/?employee_id=453&origin_id=102&first_name=alexander&last_name=jobs&birth_date=1990-01-01&token=c699d95ebbb33a1c35e2f0c8e8a44df3ba55daa7&store_department_id=64&pin_code=6607
{ "status": "ok", "career": [ { "position_id": 77, "id": 5, "end_date": "", "department_id": 64, "start_date": "2015-11-11" } ], "id": 453, "pin_code": "1605", "last_name": "jobs", "role_id": 5, "department_id": 64, "email": "rukovod1@mail.com", "middle_name": null, "first_name": "alexander" }
Удаление Сотрудника блокирует доступ Сотрудника в личный кабинет и прекращает расчет KPI Сотрудника.
На уровне базы данных удаление Сотрудника реализовано как перенос данных учетной записи в архив.
Для восстановления учетной записи обратитесь к Сотруднику SailPlay.
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | employee_id | Идентификатор Сотрудника. |
https://sailplay.ru/api/v2/partners/employees/delete/?employee_id=453&token=c699d95ebbb33a1c35e2f0c8e8a44df3ba55daa7&store_department_id=64&pin_code=6607
{ "status": "ok", "manager": { "id": 453 } }
API позволяет получить список Сотрудников по ID Отдела или по ID должности.
В случае, если соответствующие параметры не переданы, будет возвращен полный список Сотрудников.
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
нет | department_id | ID Отдела, к которому привязан Сотрудник. |
нет | position_id | ID должности Сотрудника. |
нет | page | Номер страницы выдачи. |
Название параметра | Описание параметра |
id | Идентификатор Сотрудника. |
first_name | Имя Сотрудника. |
last_name | Фамилия Сотрудника. |
position_id | ID должности Сотрудника. |
department_id | ID Отдела, к которому привязан Сотрудник. |
https://sailplay.ru/api/v2/partners/employees/list/?dep_id=64&token=c699d95ebbb33a1c35e2f0c8e8a44df3ba55daa7&store_department_id=64&pin_code=6607
{ "status": "ok", "total_pages": 1, "managers": [ { "phone": "", "id": 451, "position_id": 35, "last_name": "shan", "role_id": 1, "email": null, "pin_code": "4971", "middle_name": null, "department": 64, "first_name": "woll" }, { "phone": "", "id": 452, "position_id": 35, "last_name": "shan2", "role_id": 1, "email": null, "pin_code": "9871", "middle_name": null, "department": 64, "first_name": "will2" } ], "page": 1 }
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | employee_id | Идентификатор Сотрудника. |
В ответе будет возращена вся информацию о клиенте.
https://sailplay.ru/api/v2/partners/employees/view/?employee_id=453&token=c699d95ebbb33a1c35e2f0c8e8a44df3ba55daa7&store_department_id=64&pin_code=6607
{ "id": 453, "career": [ { "position_id": 77, "id": 5, "end_date": "", "department_id": 64, "start_date": "2015-11-11" } ], "phone": "", "birth_date": "1990-01-01", "middle_name": null, "first_name": "alexander", "pin_code": "3180", "department_id": 64, "last_name": "jobs", "role_id": 5, "status": "ok", "email": "rukovod1@mail.com" }
Этот метод не требует параметров кроме обязательных.
https://sailplay.ru/api/v2/partners/roles/list/?token=c699d95ebbb33a1c35e2f0c8e8a44df3ba55daa7&store_department_id=64&pin_code=6607
{ "status": "ok", "roles": [ { "id": 1, "name": "seller", "description": "" }, { "id": 2, "name": "manager", "description": "" }, { "id": 3, "name": "sender_manager", "description": "" }, { "id": 4, "name": "admin", "description": "" } ] }
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | employee_id | Идентификатор Сотрудника. |
да | position_id | Должность Сотрудника. |
да | dep_id | Идентификатор Отдела записи. |
да | from_date | Дата начала работы. |
нет | to_date | Дата завершения работы. Если не указан - Сотрудник в должности по сей день.. |
https://sailplay.ru/api/v2/partners/employees/career/add/?employee_id=457&position_id=77&start_date=2014-01-01&department_id=64&token=c699d95ebbb33a1c35e2f0c8e8a44df3ba55daa7&store_department_id=64&pin_code=6607
{ "status": "ok", "end_date": null, "position_id": 77, "id": 11, "department_id": 64, "start_date": "2014-01-01T00:00:00" }
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | employee_id | Идентификатор Сотрудника. |
нет | position_id | Должность Сотрудника. |
нет | dep_id | Идентификатор Отдела записи. |
нет | from_date | Дата начала работы. |
нет | to_date | Дата завершения работы. Чтобы удалить дату завершения, в значении нужно передать null. |
https://sailplay.ru/api/v2/partners/employees/career/edit/?employee_id=457&career_item_id=9&position_id=77&start_date=2012-01-01&end_date=2013-01-01&token=c699d95ebbb33a1c35e2f0c8e8a44df3ba55daa7&store_department_id=64&pin_code=6607
{ "status": "ok", "end_date": "2013-01-01T00:00:00", "position_id": 77, "id": 9, "department_id": 64, "start_date": "2012-01-01T00:00:00" }
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | employee_id | Идентификатор Сотрудника. |
https://sailplay.ru/api/v2/partners/employees/career/list/?employee_id=457&token=c699d95ebbb33a1c35e2f0c8e8a44df3ba55daa7&store_department_id=64&pin_code=6607
{ "status": "ok", "career": [ { "position_id": 77, "id": 11, "end_date": "", "department_id": 64, "start_date": "2014-01-01" }, { "position_id": 77, "id": 9, "end_date": "2013-01-01", "department_id": 64, "start_date": "2012-01-01" } ] }
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | employee_id | Идентификатор Сотрудника. |
да | career_enrty_id | Идентификатор записи карьеры. |
https://sailplay.ru/api/v2/partners/employees/career/list/?employee_id=457&career_item_id=9&token=c699d95ebbb33a1c35e2f0c8e8a44df3ba55daa7&store_department_id=64&pin_code=6607
{ "status": "ok", }
Параметр обязательный? | Имя параметра | Описание параметра |
да | token | См. здесь |
да | store_department_id | См. здесь |
да | name | Название должности. |
https://sailplay.ru/api/v2/partners/positions/add/?name=Руководитель Отдела продаж&token=c699d95ebbb33a1c35e2f0c8e8a44df3ba55daa7&store_department_id=64&pin_code=6607
{ "status": "ok", "id": 77, "name": "Руководитель Отдела продаж" }
Этот метод не требует дополнительных параметров
https://sailplay.ru/api/v2/partners/positions/list/?token=c699d95ebbb33a1c35e2f0c8e8a44df3ba55daa7&store_department_id=64&pin_code=6607
{ "status": "ok", "positions": [ { "is_default": true, "id": 35, "name": "Default position" }, { "is_default": false, "id": 77, "name": "Руководитель Отдела продаж" } ] }
Для авторизации в WEB-интерфейсе SailPlay из другой системы необходимо использовать специальный url и передать в него авторизационные данные в качестве параметров.
Параметр обязательный? | Имя параметра | Описание параметра |
да | auth_hash | Авторизационный токен, полученный в методе api/v2/partners/managers/view/ для конкретного Сотрудника |
да | partner_id | Идентификатор партнера (отображается в правом нижнем углу интерфейса или получается от Сотрудника). |
нет | config | Позволяет передать alias файла конфигурации SPanel (используется для загрузки страниц в измененных стилях). |
https://sailplay.ru/partner-login-by-hash/?auth_hash=3f95047fb74d61f9264330ae1cfa0b6e63734a3876&config=client_conf&partner_id=1681
В случае корректно подставленных данных пользователь будет авторизован в WEB-интерфейсе SailPlay
Важно! Описанный метод может быть использован только после его активации для указанного partner_id.
Для активации метода для како-либо partner_id необходимо связаться с Сотрудником SailPlay.