Миграция с версии 1.0


Этот документ содержит информацию о переводе API-клиентов с версии 1.0 на 2.0.

Несовместимые изменения

В этом разделе описаны изменения, несовместимые со старой версией API. Приложения, использующие перечисленную функциональность, должны быть обновлены.

Изменение адреса API

Для работы с новой версией вам необходимо переключить адрес API с https://beta.zenky.io на https://my.zenky.io.

Изменения в API-авторизации

Разрешения токенов

В работу авторизации пользователей API были добавлены разрешения, которые присваиваются токенам в момент их выдачи. В случае, если вы использовали API с персональным токеном, вам необходимо создать новый токен с необходимыми разрешениями в разделе персональных токенов.

Разрешения, с которыми необходимо выполнять методы, перечислены непосредственно в документации каждого метода.

Шлюзы обмена данными

API всех шлюзов очистки данных были отключены. Вместо этого вы можете воспользоваться аналогичной функцией на странице управления вашим магазином.

Телефоны

Телефоны всех ресурсов теперь являются объектами со следующей структурой:

Затронутые объекты и поля

Контакт (телефон)

Изменены:

  • value

Удалены:

  • value_formatted
Покупатель

Изменены:

  • phone

Удалены:

  • phone_formatted
Запрос обратной связи

Изменены:

  • phone

Удалены:

  • phone_formatted
Отзыв

Изменены:

  • phone

Удалены:

  • phone_formatted
Пользователь

Изменены:

  • phone

Удалены:

  • phone_formatted
Отклик на вакансию

Изменены:

  • phone

Удалены:

  • phone_formatted

Даты

В бета-версии API даты (в основном, это поля created_at и updated_at в большинстве объектов) хранили в себе отформатированное значение вида "18 апреля 2018 в 15:00". В релизной версии все поля с датами были изменены на объекты со следующей структурой:

Затронутые объекты и поля

Адрес

Изменены:

  • created_at
  • updated_at
Категория статей

Изменены:

  • created_at
  • updated_at
Статья

Изменены:

  • created_at
  • updated_at
Категория товаров

Изменены:

  • created_at
  • updated_at
Город

Изменены:

  • created_at
  • updated_at
Покупатель

Изменены:

  • birth_date
  • created_at
  • updated_at
Характеристика товара

Изменены:

  • created_at
  • updated_at
Запрос обратной связи

Изменены:

  • created_at
  • updated_at
Адрес

Изменены:

  • created_at
  • updated_at
Получатель уведомлений магазина

Изменены:

  • created_at
  • updated_at
Предложение

Изменены:

  • created_at
  • updated_at
Вариант заказа

Изменены:

  • created_at
  • updated_at
Заказ

Изменены:

  • created_at
  • updated_at
  • submitted_at

Удалены:

  • submitted_at_diff
  • submitted_at_date
  • submitted_at_time
  • submitted_at_datetime
Коллекция товаров

Изменены:

  • created_at
  • updated_at
Товар

Изменены:

  • created_at
  • updated_at
Вариант товара

Изменены:

  • created_at
  • updated_at
Отзыв

Изменены:

  • created_at
  • updated_at
Склад

Изменены:

  • created_at
  • updated_at
Магазин

Изменены:

  • created_at
  • updated_at
Пользователь

Изменены:

  • created_at
  • updated_at
Отклик на вакансию

Изменены:

  • created_at
  • updated_at
Вакансия

Изменены:

  • created_at
  • updated_at
Опция варианта

Изменены:

  • created_at
  • updated_at
Шаблон вариантов

Изменены:

  • created_at
  • updated_at

Цены

Именование полей с различным видом форматирования цен могло отличаться в разных объектах. В релизной версии API это было исправлено: теперь все цены являются объектами со следующими полями:

Затронутые объекты и поля

Вариант заказа

Изменены:

  • total_price

Удалены:

  • total_price_raw
  • total_price_formatted
Заказ

Изменены:

  • total_price
  • amount_paid
  • bonuses_amount_paid

Удалены:

  • total_price_raw
  • amount_paid_formatted
  • bonuses_amount_paid_formatted
Вариант товара

Изменены:

  • price

Удалены:

  • price_raw
  • price_formatted
Вакансия

Изменены:

  • min_salary
  • max_salary

Удалены:

  • min_salary_raw
  • max_salary_raw

Перечисления

Перечисления используются в различных объектах для определения типов, статусов, методов и т.п. В бета-версии API перечисления были выполнены в следующем виде: в поле status было указано название идентификатора перечисления (к примеру, Новый), а в поле status_identifier - значение идентификатора (к примеру, submitted).

С версии 2.0 все перечисления являются объектами со следующей структурой:

Затронутые объекты и поля

Контакт

Изменены:

  • type

Удалены:

  • type_identifier
Покупатель

Изменены:

  • gender

Удалены:

  • gender_identifier
Заказ

Изменены:

  • status
  • confirmation_status
  • delivery_method
  • payment_method

Удалены:

  • status_identifier
  • confirmation_status_identifier
  • delivery_method_identifier
  • payment_method_identifier
Пользователь

Изменены:

  • role

Удалены:

  • role_identifier
Пользователь магазина

Изменены:

  • store_role

Удалены:

  • store_role_identifier

Включения

Включения некоторых ресурсов были изменены - как их именования, так и вложенные структуры.

Товары

variants.optionValues

Включение variants.optionValues, позволяющее получить варианты и их значения опций, было переименовано в variants.option_values.

Включение variants.valuesWithOptions, позволяющее получить варианты, их значения опций и сами опции, было переименовано в variants.option_values.option.

Структура включения variants.option_values.option так же была изменена. Теперь информация об опции является вложенной в значение опции.

Заказы

Включение variants.variant.valuesWithOptions, позволяющее получить варианты товаров заказа, их значения опций и сами опции, было переименовано в variants.variant.option_values.option.

Структура включения variants.variant.option_values.option так же была изменена. Теперь информация об опции является вложенной в значение опции.