{
"swagger": "2.0",
"info": {
"description": "",
"version": "",
"termsOfService": "",
"contact": {},
"license": {
"name": " ",
"url": ""
}
},
"tags": [
{
"name": "Сервис artixcs-issuance-card для выдачи карт",
"description": "Показать/скрыть методы"
}
],
"paths": {
"/v1/issuancecard/cardnumber/{cardNumber}": {
"post": {
"tags": [
"Сервис artixcs-issuance-card для выдачи карт"
],
"summary": "Выдача карты клиенту",
"operationId": "issuanceCardUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "cardNumber",
"in": "path",
"description": "Номер карты",
"required": false,
"type": "string"
},
{
"name": "cashId",
"in": "query",
"description": "Идентификатор кассы",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"in": "body",
"name": "client",
"description": "Клиент",
"required": false,
"schema": {
"$ref": "#/definitions/Клиент"
}
},
{
"name": "clusterId",
"in": "query",
"description": "Идентификатор кластера",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "shopCode",
"in": "query",
"description": "Код магазина",
"required": false,
"type": "string",
"allowEmptyValue": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Результат работы сервиса"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v1/issuancecard/create/card": {
"post": {
"tags": [
"Сервис artixcs-issuance-card для выдачи карт"
],
"summary": "Создание виртуальной карты с помощью пинкода",
"operationId": "createClientAndVirtualCardByPinCodeUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "cashId",
"in": "query",
"description": "Идентификатор кассы",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"in": "body",
"name": "client",
"description": "Клиент",
"required": false,
"schema": {
"$ref": "#/definitions/Клиент"
}
},
{
"name": "clusterId",
"in": "query",
"description": "Идентификатор кластера",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "length",
"in": "query",
"description": "Длина генерируемой части",
"required": false,
"type": "integer",
"format": "int32",
"allowEmptyValue": false
},
{
"name": "pincode",
"in": "query",
"description": "Пин-код",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "prefix",
"in": "query",
"description": "Префикс номера карты",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "shopCode",
"in": "query",
"description": "Код магазина",
"required": false,
"type": "string",
"allowEmptyValue": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Результат работы сервиса"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v1/issuancecard/create/card/anonymous/{cardNumber}": {
"post": {
"tags": [
"Сервис artixcs-issuance-card для выдачи карт"
],
"summary": "Создание карты по номеру ранее зарезервированной анонимной карты",
"operationId": "createCardByAnonymousCardNumberUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "cardNumber",
"in": "path",
"description": "Номер карты",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "client",
"description": "Клиент",
"required": false,
"schema": {
"$ref": "#/definitions/Клиент"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Результат работы сервиса"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v1/issuancecard/noverify/create/card": {
"post": {
"tags": [
"Сервис artixcs-issuance-card для выдачи карт"
],
"summary": "Создание виртуальной карты без пинкода",
"operationId": "createClientAndVirtualCardNoPinCodeUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "cashId",
"in": "query",
"description": "Идентификатор кассы",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"in": "body",
"name": "client",
"description": "Клиент",
"required": false,
"schema": {
"$ref": "#/definitions/Клиент"
}
},
{
"name": "clusterId",
"in": "query",
"description": "Идентификатор кластера",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "length",
"in": "query",
"description": "Длина генерируемой части",
"required": false,
"type": "integer",
"format": "int32",
"allowEmptyValue": false
},
{
"name": "prefix",
"in": "query",
"description": "Префикс номера карты",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "shopCode",
"in": "query",
"description": "Код магазина",
"required": false,
"type": "string",
"allowEmptyValue": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Результат работы сервиса"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v1/issuancecard/reserve/card/anonymous": {
"get": {
"tags": [
"Сервис artixcs-issuance-card для выдачи карт"
],
"summary": "Резервирование анонимной виртуальной карты",
"operationId": "createVirtualCardAnonymousUsingGET",
"produces": [
"*/*"
],
"parameters": [
{
"name": "length",
"in": "query",
"description": "Длина генерируемой части",
"required": false,
"type": "integer",
"format": "int32",
"allowEmptyValue": false
},
{
"name": "prefix",
"in": "query",
"description": "Префикс номера карты",
"required": false,
"type": "string",
"allowEmptyValue": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Результат работы сервиса"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v1/issuancecard/verify/phonenumber": {
"post": {
"tags": [
"Сервис artixcs-issuance-card для выдачи карт"
],
"summary": "Получение пинкода для создания клиента/карты",
"operationId": "getVerificationCodeForCreatingVirtualCardUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "cashId",
"in": "query",
"description": "Идентификатор кассы",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"in": "body",
"name": "client",
"description": "Клиент",
"required": false,
"schema": {
"$ref": "#/definitions/Клиент"
}
},
{
"name": "clusterId",
"in": "query",
"description": "Идентификатор кластера",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "shopCode",
"in": "query",
"description": "Код магазина",
"required": false,
"type": "string",
"allowEmptyValue": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Результат работы сервиса"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/version": {
"get": {
"tags": [
"Сервис artixcs-issuance-card для выдачи карт"
],
"summary": "Получить версию сервиса",
"operationId": "getVersionUsingGET",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
}
},
"definitions": {
"Клиент": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Адрес клиента"
},
"birthday": {
"type": "string",
"format": "date-time",
"description": "День рождения"
},
"childrencount": {
"type": "integer",
"format": "int32",
"description": "Количество детей клиента"
},
"codeword": {
"type": "string",
"description": "Кодовое слово"
},
"document": {
"type": "string",
"description": "Данные документа клиента (паспорт, водительское удостоверение и т.д.)"
},
"email": {
"type": "string",
"description": "Электронный адрес (E-mail)"
},
"extendedoptions": {
"type": "string",
"description": "Дополнительные параметры"
},
"idclient": {
"type": "string",
"description": "Идентификационный номер клиента"
},
"inn": {
"type": "string",
"description": "ИНН"
},
"name": {
"type": "string",
"description": "ФИО клиента"
},
"occupation": {
"type": "string",
"description": "Род занятий"
},
"okpd": {
"type": "string",
"description": "ОКПД"
},
"okpo": {
"type": "string",
"description": "ОКПО"
},
"options": {
"type": "integer",
"format": "int32",
"example": "0 – нет установленных опций, 1 – отправлять чек на e-mail, 2 – e-mail подтвержден",
"description": "Дополнительные опции"
},
"organizationcode": {
"type": "string",
"description": "Уникальный код организации"
},
"phonenumber": {
"type": "string",
"description": "Телефонный номер клиента"
},
"sex": {
"type": "integer",
"format": "int32",
"example": "0 - мужской, 1 - женский",
"description": "Пол клиента"
},
"specialdate1": {
"type": "string",
"format": "date-time",
"description": "Первая особая дата клиента"
},
"specialdate1name": {
"type": "string",
"description": "Название первой особой(специальной) даты"
},
"specialdate2": {
"type": "string",
"format": "date-time",
"description": "Вторая особая дата клиента"
},
"specialdate2name": {
"type": "string",
"description": "Название второй особой(специальной) даты"
},
"specialdate3": {
"type": "string",
"format": "date-time",
"description": "Третья особая дата клиента"
},
"specialdate3name": {
"type": "string",
"description": "Название третьей особой(специальной) даты"
},
"subscriptionadj": {
"type": "integer",
"format": "int32",
"example": "0 или NULL – не согласен на рассылку, 1 – согласен на рассылку",
"description": "Согласие на рассылку"
},
"text": {
"type": "string",
"description": "Дополнительная информация"
},
"userid": {
"type": "string",
"description": "Идентификатор пользователя"
},
"webpage": {
"type": "string",
"description": "Web-страница"
},
"zipcode": {
"type": "string",
"description": "Почтовый индекс клиента"
}
},
"title": "Клиент"
},
"Результат работы сервиса": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Сообщение о результате работы"
},
"status": {
"type": "integer",
"format": "int32",
"example": "0 - успешно, 1 - Не указан номер телефона пользователя, 2 - Клиент с указанным номером уже создан, 3 - Пользователь с указанным номером телефона создан и имеет карту, 4 - Карта с указанным номером не существует, 5 - Отсутствует идентификатор клиента, 6 - Карт с указанным номером больше одной, 7 - Карта уже привязана к клиенту, 8 - Клиент не должен быть пустым, 9 - Генерация справочника завершилась неуспешно, 10 - Карту не удалось привязать к пользователю, 11 - Ошибка при обработке телефонного номера, 12 - Ошибка при создании карты на КС, 13 - Ошибка пинкода, либо не соответствует, тому, что хранится в кеше, либо истек, 14 - Пинкод не передан, либо пустой, 15 - Ошибка, при которой существует несколько клиентов с одним номером телефона, 16 - Ошибка при создании бонусной карты на бонусном сервере, 17 - В процессе запроса кода верификации для телефона с кассового сервера произошла ошибка, 18 - Некорректная длина номера карты, длина карты должна принимать значения от 4 до 200 символов, 19 - Некорректное отношение длины префикса номера карты к длине генерируемой части номера карты, 20 - Ошибка генерации номера карты, исчерпаны все попытки сгенерировать номер карты, увеличьте длину генерируемой части,21 - Карта не была зарезервирована перед созданием, 100 - Неизвестная ошибка",
"description": "Статус операции"
},
"success": {
"type": "boolean",
"example": false,
"description": "Флаг результата"
}
},
"title": "Результат работы сервиса"
}
}
}
Overview
Content Tools