Блог

Новое API в retailCRM. Интегрируйся, кто может!

С самого появления retailCRM продукт предоставлял API для интеграции с другими сервисами, интернет-магазинами и системами учета. Мы делали API по возможности простым и в то же время функциональным. Сегодня мы хотим сообщить о появлении нового API версии 3 и рассказать, что в ней появилось.

Ильяс Салихов 5 декабря 2014 года

Настройка прав доступа

Управление API-ключами

Мы вынесли работу с API-ключами в отдельный раздел. На каждый магазин вы можете завести неограниченное количество ключей. Можно сделать и обратное: одному ключу предоставить доступ к данным нескольких магазинов. Кроме того вы можете индивидуально для каждого ключа задать перечень разрешенных методов API.

Редактирование API-ключа

Все это позволяет гибко настраивать политику прав доступа, что бывает критично при большом количестве интеграций с внешними сервисами. Например, вы можете создать отдельный ключ для партнерской CPA-сети и разрешить для ключа только метод создания заказа в CRM и метод получения статуса заказа, запретив все остальные методы.

Новые методы API

В API появился целый ряд новых полезных методов. Приведем самые интересные из них.

Методы /api/v3/orders и /api/v3/customers

Даннные методы позволяют получать перечень заказов и клиентов, отфильтрованных по тем или иным параметрам. Методы позволяют фильтровать данные в общей сложности почти по 100 различным полям, в том числе по пользовательским полям, которые вы создаете в CRM самостоятельно.

Давайте покажем вам некоторые примеры того, что вы можете выбрать с помощью данных методов API:

  • Заказы за вчерашний день
  • Заказы, оформленные по телефону
  • Заказы, в которых заказан какой-либо конкретный товар (например, iPhone 6)
  • Заказы с доставкой на сегодня
  • Клиенты, пришедшие по рекламному объявлению в Яндекс.Директ
  • Клиенты со средним чеком выше 5000 рублей
  • Важные клиенты
  • Клиенты из определенного RFM-сегмента

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

Метод /api/v3/orders/statuses

Теперь вы можете с помощью метода /api/v3/orders/statuses получить статусы для определенных заказов. За один запрос можно получить статусы до 500 заказов. Это может быть очень полезно, например, при интеграции с CPA-сетями.

Полностью обновленная документация

Мы уделили отдельное внимание документации для разработчиков и постарались сделать ее по возможности подробной и понятной.

Теперь подробно описаны общие принципы работы с API, а также опубликовано подробнейшее описание методов API с детализацией до полей.

Кроме того, мы описали, чем версии API отличаются друг от друга. В данный момент мы рекомендуем использовать последнюю версии v3, т.к. она предоставляет максимальные возможности. Предыдущие версии доступны и оставлены для совместимости, но в будущем (примерно через год) будут отключены.

Новый API-клиент для PHP

Одновременно с выходом новой версии API мы подготовили новую версию PHP-клиента для работы с API.

Репозиторий: https://github.com/retailcrm/api-client-php
Composer-пакет: https://packagist.org/packages/retailcrm/api-client-php

Для работы клиента требуется PHP версии 5.3 или выше, cURL-расширение и Composer. Если ваш хостинг не позволяет использовать что-либо из перечисленного (что в наше время редкость, но иногда встречается), вы можете воспользоваться нашими примерами работы с API низкоуровневыми методами http://www.retailcrm.ru/docs/Разработчики/ВзаимодействиеСAPIПриОграниченияхХостинга. Это менее удобно, но работает даже в самых суровых условиях :)

Готовые модули для CMS

Мы постоянно расширяем список модулей интеграции с CMS, и в данный момент разработаны модули интеграции для 1С-Битрикс, inSales, OpenCart, Webasyst и ShopScript. 

Что ожидается дальше

Работа по развитию API никогда не останавливается, и мы в ближайшем будущем планируем добавить:

  • Работу с задачами
  • Работу с сегментами клиентов
  • Механизм Web-hooks (через триггеры)
  • Работу с остатками и резервами

Кроме того в ближайшее время ожидается целый ряд новых встроенных интеграций, следите за анонсами!

Подпишись
на канал retailCRM!
  • Обучающие материалы
  • Видео настроек полезных фич
  • Обзоры новинок retailCRM
  • Кейсы с опытными
    бизнесменами
  • Записи вебинаров
Подписаться
Понравилась статья?
расскажите о ней друзьям!