Последовательность взаимодействия партнера и Cardsmobile представлена на диаграмме ниже.
где:
ИС партнера — информационная система партнера, организовавшего выпуск подарочных сертификатов (карт) через приложение «Кошелёк»;
Файловое хранилище — хранилище файлов для обмена данными и сервер sFTP, организованные на стороне Cardsmobile;
Сервер Кошелька — компонент платформы Cardsmobile, обеспечивающий взаимодействие с партнерами, выпуск подарочных сертификатов (карт) в приложении «Кошелёк», осуществляющий подготовку отчетов и реестров выпущенных карт.
Партнер загружает свои файлы реестров в папку in, файл реестра, формируемый Кошельком, партнер выгружает из папки out.
Реестр передается партнером с установленной периодичностью (рекомендуемая периодичность передачи реестра – не реже одного раза в сутки). Схема именования файла:
NewCertificate_<имя партнера>_<номинал>_<дата>.csv.zip
где:
<имя партнера> – согласованное с Cardsмobile имя Партнера (без пробелов);
<номинал> – номинал сертификатов, находящихся в файле реестра;
<дата> – дата формирования реестра в формате ГГГГММДД.
Пример имени файла реестра предактивированных сертификатов (подарочных карт):
NewCertificate_PartnerName_500_20180131.csv.zip
В файле передаются следующие поля в указанном порядке:
number
– Номер (код) сертификата (подарочной карты). Обязательный параметр;
barcode
– Номер сертификата, из которого генерируется штрих-код либо QR-код сертификата (подарочной карты);
startDate
– Дата начала действия сертификата (подарочной карты);
expireDate
– Дата окончания действия сертификата (подарочной карты).
Пример:
<заголовок, игнорируется>ID111218300541871830;X51BA30AFB526AC1E0;;2018-09-20T07:00:33ID111218300541871111;X51BA30AFB526AC111;;2018-09-20T07:00:33
Примеры заполнения полей типа «дата»:
Дата: 2018-11-27
;
Дата и время: 2018-09-20T07:00:33
;
Дата и время с временной зоной: 2018-09-20T07:00:33.123+0300
.
Основным идентификатором сертификата (подарочной карты) является поле number
, а дополнительным – поле barcode
.
Реестр передается партнером с установленной периодичностью (рекомендуемая периодичность передачи реестра – не реже одного раза в сутки). Схема именования файла:
UpdIssuedCertificate_<имя партнера>_<номинал>_<дата>.csv.zip
где:
<имя партнера> – согласованное с Cardsмobile имя Партнера (без пробелов);
<номинал> – номинал сертификатов, находящихся в файле реестра;
<дата> – дата формирования реестра в формате ГГГГММДД.
Пример имени файла реестра обновлений сертификатов (подарочных карт):
UpdIssuedCertificate_PartnerName_500_20180131.csv.zip
В файле передаются следующие поля (в указанном порядке):
number
– Номер (код) сертификата (подарочной карты). Обязательный параметр;
startDate
– Дата начала действия сертификата (подарочной карты);
expireDate
– Дата окончания действия сертификата (подарочной карты);
useDate
– Дата использования сертификата (подарочной карты);
status
– Статус сертификата (если установлено blocked, то сертификат досрочно блокируется).
Пример:
<заголовок, игнорируется>ID111218300541871830;;;;ID111218300541871111;;;;
Примеры заполнения полей типа «дата»:
Дата: 2018-11-27
;
Дата и время: 2018-09-20T07:00:33
;
Дата и время с временной зоной: 2018-09-20T07:00:33.123+0300
.
Реестр выпущенных сертификатов (подарочных карт) выгружается сервером Кошелька на файловое хранилище ежедневно. Дата выгрузки файла в точности совпадает с датой выдачи сертификатов (подарочных карт). Схема именования файла:
IssuedCertificate_<имя партнера>_<номинал>_<дата>.csv.zip
где:
<имя партнера> – согласованное с Cardsмobile имя Партнера (без пробелов);
<номинал> – номинал сертификатов, находящихся в файле реестра;
<дата> – дата формирования реестра в формате ГГГГММДД.
Пример имени файла реестра сертификатов (подарочных карт), выпущенных Cardsmobile
IssuedCertificate_PartnerName_500_20180131.csv.zip
Для каждого номинала сертификатов (подарочных карт) формируется собственный файл.
В файле передаются следующие поля:
number
– Номер (код) сертификата (подарочной карты). Обязательный параметр.
Пример:
<заголовок, игнорируется>ID111218300541871830ID111218300541871831
С целью оперативного попадания сведений о сертификатах (подарочных картах), выпущенных для партнера в Кошельке, рекомендуется загружать реестр сертификатов, выпущенных Cardsmobile, не реже одного раза в сутки.