Skip to main content

Работа с API и Вебхуками

Работа с API

  • Доступ по API к данным сайта включается в панели управления в разделе "Настройка / Доступ → Доступность API". Там же расположены ключи доступа (Public Key и Private Key), которые потребуются при работе с API.
  • Обращаем внимание, что после включения доступа по API должно пройти около 30 минут для активации доступа.
  • С полным списком API-методов можно ознакомиться на https://api.pixlpark.com/, пройдя процедуру авторизации через Public Key и Private Key.
  • Общий алгоритм работы с API следующий:
    1. Получить Request Token, вызвав метод "Get Request Token".
    2. Получить Access Token, вызвав метод "Get Access Token", передав Request Token, Public Key и Private Key.
    3. Вызвать любой API-метод, передав Access Token.
  • Все API-методы разбиты на следующие группы:
    • Authentication - методы получения доступа к API.
    • Orders - методы работы с заказами.
    • Users - методы работы с клиентами.
    • Categories - методы работы с категориями печати.
    • Products - методы работы с продуктами.
    • Options - методы работы с опциями.
    • Shopping Cart - методы работы с корзинами пользователей.
    • Shippings - методы работы с доставками.
    • Suppliers - методы работы с подрядчиками.
    • Discounts - методы работы со скидками.
    • Templates - методы работы с шаблонами.
    • Cliparts - методы работы с клипартами. *

Работа с Вебхуками

  • Еще одним способом обмена данными с сайтом является технология вебхукинга, которая позволяет получать информацию при изменении каких-либо объектов системы.
  • Соответственно, при возникновении события на сайте Pixlpark отправляет запрос по определенному URL-адресу, который содержит JSON с данными измененного объекта.
  • На данный момент в Pixlpark реализовано лишь несколько событий, однако их список можно расширять по запросу в техническую поддержку.
  • Сами вебхуки настраиваются в панели управления в разделе "Маркетинг / Уведомления → Настройка вебхуков" (инструкция).