GrowCards Passes API v2

Для интеграции GrowCards в вашу внутреннюю систему используйте методы, описанные на этой странице.

Коллекция в Postman

Мы создали коллекцию в Postman с описанными ниже методами и всеми необходимыми параметрами для удобного тестирования запросов.

JSON коллекции

Список карт

GET https://api.growcards.ru/v2/passes

Получение списка выпущенных карт. По умолчанию возвращает все карты, созданные в рамках компании. Для получения карт, созданных в рамках шаблона, укажите в параметрах запроса templateId

Query Parameters

Name
Type
Description

limit

number

Количество карт на страницу (по умолчанию 10)

page

number

Номер страницы

template

string

ID шаблона

Headers

Name
Type
Description

X-SECRET-KEY

string

Интеграционный ключ компании

{
    "data": [
        {
            "_id": "5e491ad54ebdb3640ff47a09",
            "name": "Петр Иванов",
            "serialNumber": "3239950756",
            "company": {
                "name": "2MOOD"
            },
            "template": {
                "name": "Карта 2MOOD"
            },
            "created_at": "2020-02-16T10:35:01.554Z",
            "devices": [
                {
                    "os": "ios",
                    "application": "apple wallet"
                }
            ]
        },
        {...}
    ],
    "meta": {
        "total": 7,
        "limit": 10,
        "page": 1,
        "pages": 1
    }
}

Объект карты по ID

GET https://api.growcards.ru/v2/passes/:passId

Получение данных выпущенной карты.

Path Parameters

Name
Type
Description

passId

string

ID карты клиента

Headers

Name
Type
Description

X-SECRET-KEY

string

Интеграционный ключ компании

{
    "_id": "5e468c805d8d34644ebb34e6",
    "formDataFields": [
        {
            "key": "email",
            "value": "[email protected]"
        }
    ],
    "name": "Вячеслав Осадчий",
    "phone": "79218678737",
    "serialNumber": "1282295653",
    "company": {
        "name": "2MOOD"
    },
    "template": {
        "name": "Карта 2MOOD"
    },
    "created_at": "2020-02-14T12:03:12.891Z",
    "devices": [
        {
            "os": "ios",
            "application": "apple wallet",
            "created_at": "2020-02-14T12:05:32.194Z"
        }
    ],
    "fields": [
        {
            "key": "discount",
            "label": "Ваша скидка",
            "value": "10%",
            "enabled": true,
            "changeMessage": "У вас новая скидка: %@"
        },
        {
            "key": "levelname",
            "label": "Уровень",
            "value": "Welcome",
            "enabled": true,
            "changeMessage": "У вас новый уровень: %@"
        }
    ]
}

Объект карты по серийному номеру

GET https://api.growcards.ru/v2/passes/s/:serialNumber

Получение данных выпущенной карты по серийному номеру.

Path Parameters

Name
Type
Description

serialNumber

string

Серийный номер карты

Headers

Name
Type
Description

X-SECRET-KEY

string

Интеграционный ключ компании

{
    "_id": "5e468c805d8d34644ebb34e6",
    "formDataFields": [
        {
            "key": "email",
            "value": "[email protected]"
        }
    ],
    "name": "Вячеслав Осадчий",
    "phone": "79218678737",
    "serialNumber": "1282295653",
    "company": {
        "name": "2MOOD"
    },
    "template": {
        "name": "Карта 2MOOD"
    },
    "created_at": "2020-02-14T12:03:12.891Z",
    "devices": [
        {
            "os": "ios",
            "application": "apple wallet",
            "created_at": "2020-02-14T12:05:32.194Z"
        }
    ],
    "fields": [
        {
            "key": "discount",
            "label": "Ваша скидка",
            "value": "10%",
            "enabled": true,
            "changeMessage": "У вас новая скидка: %@"
        },
        {
            "key": "levelname",
            "label": "Уровень",
            "value": "Welcome",
            "enabled": true,
            "changeMessage": "У вас новый уровень: %@"
        }
    ]
}

Создание карты

POST https://api.growcards.ru/v2/passes

Создание клиентской карты на основе шаблона.

Headers

Name
Type
Description

X-SECRET-KEY

string

Интеграционный ключ компании

Request Body

Name
Type
Description

surname

string

Фамилия владельца

name

string

Имя владельца

phone

string

Номер телефона

template

string

ID шаблона

{
    "id": "6058f4c296d7dc2fb8b6ea52",
    "serialNumber": "9024585895"
}

Пример тела запроса

{
	"phone": "79211234567",
	"name": "Иван",
	"surname": "Иванов",
	"template": "604fde02f8a4763d25469445"
}

Обновление данных карты по ID

PUT https://api.growcards.ru/v2/passes/:passId

Метод для обновления информации на карте клиента по ID карты. После каждого обновления на устройство пользователя, где установлена карта отправляется PUSH уведомление. Серийный номер карты содержится в данных штрих-кода на электронной карте клиента.

Path Parameters

Name
Type
Description

passId

string

ID карты клиента

Headers

Name
Type
Description

X-SECRET-KEY

string

Интеграционный ключ компании

Request Body

Name
Type
Description

phone

string

Телефон владельца карты

name

string

Имя владельца карты

fields

object

Объект с полями из шаблона карты в формате ключ:значение

{
    "id": "604fe30a25e0573d50bd131a",
    "serialNumber": "5064375019"
}

Обновление данных карты по серийному номеру

PUT https://api.growcards.ru/v2/passes/s/:serialNumber

Метод для обновления карты клиента по серийному номеру

Path Parameters

Name
Type
Description

serialNumber

string

Серийный номер карты

Headers

Name
Type
Description

X-SECRET-KEY

string

Интеграционный ключ компании

Request Body

Name
Type
Description

phone

string

Телефон владельца карты

name

string

Им владельца карты

fields

object

Объект с полями из шаблона карты в формате ключ:значение

{
    "id": "604fe30a25e0573d50bd131a",
    "serialNumber": "5064375019"
}

Пример тела запроса

{
	"name": "Иван Иванов",
	"phone": "79211234567",
	"fields": {
		"bonuses": "220" 
	}
}

Отправка PUSH-уведомления по ID карты

POST https://api.growcards.ru/v2/passes/:passId/notification

Отправка текстового PUSH-уведомления на карту по ID карты.

Path Parameters

Name
Type
Description

passId

string

ID карты клиента

Headers

Name
Type
Description

X-SECRET-KEY

string

Интеграционный ключ компании

Request Body

Name
Type
Description

message

string

Текст уведомления

{
    "id": "604fe30a25e0573d50bd131a",
    "serialNumber": "5064375019",
    "message": "Текстовое уведомление!"
}

Отправка PUSH-уведомления по серийному номеру

POST https://api.growcards.ru/v2/passes/s/:serialNumber/notification

Отправка текстового PUSH-уведомления на карту по серийному номеру карты.

Path Parameters

Name
Type
Description

serialNumber

string

Серийный номер карты

Headers

Name
Type
Description

X-SECRET-KEY

string

Интеграционный ключ компании

Request Body

Name
Type
Description

message

string

Текст уведомления

{
    "id": "604fe30a25e0573d50bd131a",
    "serialNumber": "5064375019",
    "message": "Текстовое уведомление!"
}

Групповая отправка PUSH-уведомлений

POST https://api.growcards.ru/v2/templates/:templateId/notification

Отправка текстового PUSH-уведомления всем картам в заданном шаблоне, либо выбранным картам

Path Parameters

Name
Type
Description

templateId

string

ID шаблона

Headers

Name
Type
Description

X-SECRET-KEY

string

Интеграционный ключ компании

Request Body

Name
Type
Description

cards

string

Массив с ID карт

message

string

Текст уведомления

{
    "count": 7, // количество карт 
    "message": "Групповое уведомление"
}

Last updated

Was this helpful?