Создавайте и обновляйте карты Wallet, когда данные меняются в CRM, и читайте данные из
CARDPR. Передавайте app_key — приватный ключ со вкладки API keys в разделе
Интеграция. У аккаунта может быть несколько ключей. Тип master — основной.
Ключ lite и другие дополнительные ключи вызывают те же методы, лимиты у каждого
свои. Публичный ключ со вкладки Public key нужен только в адресе входящего хука, в
app_key его не передают. Для тестов подойдёт
Postman.
1.1 status
Проверка приватного ключа, статуса аккаунта и лимитов этого ключа. Вызов учитывается в лимитах ключа.
POST https://core.cardpr.com/api/v2/status
Запрос
{
"app_key": "приватный_ключ"
}
Ответ
{
"app": "account_name",
"balance": 15000.00,
"key": {
"type": "master",
"sent_hour": 202,
"limit_hour": 3600,
"limit_sec": 1,
"blocked": false,
"total": 835867,
"last": "2026-10-08 12:05:00"
}
}
1.2 user_create_or_update
Создание или обновление клиента в CARDPR. Ключ: номер телефона в формате E.164. Можно
передавать пользовательские переменные. template_uuid смотрите в адресной
строке шаблона.
POST
https://core.cardpr.com/api/v2/crm/user_create_or_update
Запрос
{
"app_key": "приватный_ключ",
"name": "имя",
"phone": "мобильный телефон клиента",
"email": "электронная почта",
"surname": "фамилия",
"middlename": "отчество",
"birthday": "дата рождения dd.mm.yyyy",
"discount": "размер скидки в %",
"bonus": "размер бонуса в %",
"balance": "количество бонусов",
"card_track": "...",
"template_uuid": "...",
"customerId": "идентификатор клиента в вашей CRM",
"link": "ссылка на форму выдачи карт",
"sms": "Предлагаем установить карту: %link%"
}
Чтобы отправить персональную ссылку на установку, передайте URL формы в
link. В тексте SMS %link% заменится на эту ссылку.
Ответ
{
"success": true,
"sms_send": true,
"card": true,
"card_number": "номер созданной карты",
"card_track": "трек созданной карты",
"card_url": "персональная ссылка Apple Wallet",
"card_gpay_url": "персональная ссылка Google Wallet",
"form_url": "персональная ссылка на форму",
"user_hash": "hash для персонализации формы"
}
Создать клиента и отправить SMS
{
"app_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"phone": "+79111111111",
"email": "",
"name": "Илья",
"surname": "Орлов",
"middlename": "Андреевич",
"birthday": "11.11.1980",
"discount": 0,
"bonus": 3.50,
"balance": 100,
"link": "https://form.cardpr.com/00000000-0000-0000-0000-000000000000",
"sms": "Ваша карта доступна по ссылке: %link%"
}
Пример SMS
Ваша карта доступна по ссылке: https://form.cardpr.com/00000000-0000-0000-0000/?hash=2f10171a33f66f3bc425335690ec880c
Изменение баланса
Если в шаблоне настроен push на изменение баланса, клиент увидит сообщение на экране
блокировки. Чтобы начислить или списать сумму, используйте
balance/add и
balance/deduct.
{
"app_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"phone": "+79111111111",
"balance": 120
}
Персональный push на карту
При отправке пуша не меняйте переменные, к которым привязаны уведомления в шаблоне. Если
отправить пуш и одновременно изменить такую переменную, уйдёт системное уведомление, что
карта изменилась.
{
"app_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"phone": "79111111111",
"push": "Ваш заказ готов к выдаче!"
}
Web push
Нужно подключённое webpush-приложение из Маркетплейса.
{
"app_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"phone": "+79111111111",
"send_webpush": "Ваш заказ готов к выдаче!"
}
1.3 read_customer
Получение данных клиента по номеру телефона или номеру карты. Телефон в формате E.164.
POST https://core.cardpr.com/api/v2/crm/read_customer
Запрос: phone или card
{
"app_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"phone": "",
"card": "",
"invites": true,
"installs": true
}
Ответ
{
"customer": {
"phone": "+79111111111",
"email": "",
"name": "Илья",
"surname": "Орлов",
"middlename": "Андреевич",
"birthday": "11.11.1980",
"cardNumbers": ["120"],
"cardTracks": [{"card": "120", "track": "78374598987"}],
"cardInstalls": [{"card": "120", "install": true}],
"discount": 4.5,
"bonus": 0,
"balance": 0,
"template_uuid": "...",
"remoteId": "6326",
"invitedBy": "+79000000000",
"invites": ["+79000000011", "+79000000012"]
}
}
1.4 read_customers
Список клиентов по дате регистрации.
POST https://core.cardpr.com/api/v2/crm/read_customers
Запрос
{
"app_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"start_date": "01.01.2020",
"end_date": "31.12.2020 23:59:59",
"installed": true,
"offset": 0
}
- Если
installed не указан, метод вернёт всех клиентов.
- Если
true: клиенты с установленной картой.
- Если
false: клиенты без установленной карты.
-
Возвращает первых 100 клиентов. Для следующей страницы используйте
offset.
Ответ
{
"customers": ["+79000000011", "+79000000012"]
}
1.5 push/create
Создать push-рассылку по всей базе или сегменту. Тип: push или
webpush. Для webpush нужно приложение из Маркетплейса. После создания
отправьте рассылку методом push/send. Для одиночного пуша
используйте user_create_or_update.
segment_uuid в адресной строке сегмента.
POST https://core.cardpr.com/api/v2/crm/push/create
Запрос
{
"app_key": "",
"message": "",
"type": "",
"name": "",
"segment_uuid": ""
}
Ответ
{
"result": {
"name": "Push#0000",
"uuid": "00000000-0000-0000-0000-000000000000",
"message": "Тестовый push!"
}
}
1.7 event/send
Отправить событие по клиенту. Обязательны app_key, event и один
идентификатор клиента: phone, card или remoteId.
Ключ event создаётся в разделе «События» кабинета.
value — необязательная строка до 100 символов. Телефон в формате E.164.
POST https://core.cardpr.com/api/v2/crm/event/send
Запрос с phone
{
"app_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"phone": "+79111111111",
"event": "site_visit",
"value": "promo"
}
Запрос с card
{
"app_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"card": "1000123456",
"event": "site_visit",
"value": "promo"
}
Запрос с remoteId
{
"app_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"remoteId": "crm-42",
"event": "site_visit",
"value": "promo"
}
Ответ
1.8 balance/add
Начислить бонусный баланс клиента. Та же операция, что кнопка «Начислить» в карточке
клиента. Обязательны app_key, sum и один идентификатор клиента:
phone, card или remoteId.
sum — положительная сумма, которая прибавляется к текущему балансу.
Для своей базы Passquare меняет баланс сам. Если подключена внешняя CRM, Passquare
отправляет ей хук addBalance, как кнопка «Начислить», и затем
обновляет карту по данным CRM.
Телефон в формате E.164. Если в шаблоне к изменению баланса привязан push, клиент
также увидит сообщение на экране блокировки.
POST
https://core.cardpr.com/api/v2/crm/balance/add
Запрос с phone
{
"app_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"phone": "+79111111111",
"sum": 50.00
}
Запрос с card
{
"app_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"card": "100099",
"sum": 50.00
}
Запрос с remoteId
{
"app_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"remoteId": "crm-42",
"sum": 50.00
}
Ответ
{
"success": true,
"balance": 150.00
}
1.9 balance/deduct
Списать бонусный баланс клиента. Та же операция, что кнопка «Списать» в карточке
клиента. Обязательны app_key, sum и один идентификатор клиента:
phone, card или remoteId.
sum — положительная сумма, которая вычитается из текущего баланса.
Для своей базы Passquare меняет баланс сам. Если подключена внешняя CRM, Passquare
отправляет ей хук addBalance, как кнопка «Списать», и затем
обновляет карту по данным CRM.
Телефон в формате E.164. Если в шаблоне к изменению баланса привязан push, клиент
также увидит сообщение на экране блокировки.
POST
https://core.cardpr.com/api/v2/crm/balance/deduct
Запрос с phone
{
"app_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"phone": "+79111111111",
"sum": 50.00
}
Запрос с card
{
"app_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"card": "100099",
"sum": 50.00
}
Запрос с remoteId
{
"app_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"remoteId": "crm-42",
"sum": 50.00
}
Ответ
{
"success": true,
"balance": 50.00
}