GrowCards Passes API v2
Для интеграции GrowCards в вашу внутреннюю систему используйте методы, описанные на этой странице.
Мы создали коллекцию в Postman с описанными ниже методами и всеми необходимыми параметрами для удобного тестирования запросов.
GrowCards API V2.postman_collection.json
10KB
Code
JSON коллекции
get
https://api.growcards.ru
/v2/passes
Список карт
Метод поддерживает пагинацию. Если параметр page не указан, то будут возвращены все карты.
При включенной пагинации по умолчанию отдаётся 10 объектов на страницу. Вы можете изменить это через параметр limit.
get
https://api.growcards.ru
/v2/passes/:passId
Объект карты по ID
get
https://api.growcards.ru
/v2/passes/s/:serialNumber
Объект карты по серийному номеру
post
https://api.growcards.ru
/v2/passes
Создание карты
{
"phone": "79211234567",
"name": "Иван",
"surname": "Иванов",
"template": "604fde02f8a4763d25469445"
}
put
https://api.growcards.ru
/v2/passes/:passId
Обновление данных карты по ID
put
https://api.growcards.ru
/v2/passes/s/:serialNumber
Обновление данных карты по серийному номеру
{
"name": "Иван Иванов",
"phone": "79211234567",
"fields": {
"bonuses": "220"
}
}
Если в объекте fields переданы ключи полей, отсутствующие в шаблоне, то сервис вернет ошибку 400 и список ошибочных полей.
В теле запроса обязателен как минимум один параметр. При отправке обновления с несколькими параметрами в PUSH-уведомлении отобразится сообщение "Данные карты обновлены", поэтому мы рекомендуем отправлять обновление с одним параметром для отображения в уведомлении уникального сообщения с обновленными данными.
Обратите внимание
Если обновляемые данные совпадают с текущими данными на карте пользователя, то PUSH-уведомление не придет, т.к. в карте не будет обновлений.
post
https://api.growcards.ru
/v2/passes/:passId/notification
Отправка PUSH-уведомления по ID карты
post
https://api.growcards.ru
/v2/passes/s/:serialNumber/notification
Отправка PUSH-уведомления по серийному номеру
Обратите внимание
Если отправляемое сообщение полностью совпадает с последним отправленным сообщением, то PUSH-уведомление не придет, т.к. в карте не будет обновлений.
post
https://api.growcards.ru
/v2/templates/:templateId/notification
Групповая отправка PUSH-уведомлений
Если переданный массив cards пустой, то уведомление будет отправлено всем картам в шаблоне.
Last modified 2yr ago