> For the complete documentation index, see [llms.txt](https://passteam.gitbook.io/passteam-api-v1/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://passteam.gitbook.io/passteam-api-v1/untitled.md).

# Информация о клиенте

**Описание:**\
Для получения информации об определенном клиенте используется метод **getcard**. Карту можно искать или по системным параметрам Passteam (cardId или cardCode), или по значениям переменных (values).

**Как использовать:**\
Метод обычно используется при необходимости получить ссылку на существующую карту. Например, метод можно использовать при интеграции выдачи карт на сайте.

## getCard

<mark style="color:green;">`POST`</mark> `https://getpass.passteam.ru/oapi/v1/getcard`

Поиск карты по cardId или cardCode

#### Request Body

| Name       | Type   | Description                                                                                                                                                           |
| ---------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| cardId     | string | Уникальный ID карты. Поиск сначала производится по cardId, если он указан. Если нет, то поиск осуществляется по связке templateId и cardCode или templateId и values. |
| templateId | string | Идентификатор шаблона. Обязательно при поиске карты по cardCode или values.                                                                                           |
| cardCode   | string | Девятизначный код карты с ведущими нулями.                                                                                                                            |

{% tabs %}
{% tab title="200 cardId - идентификатор карты в системе;
cardCode - номер карты в решении. Формируется автоматически начиная с 000000001;
cardUrl - ссылка на скачивание карты. Определяет ОС устройства и предлагает установить соответствующую карту;
appleUrl - ссылка на скачивание Apple Wallet карты (pkpass файл);
googleUrl - ссылка на скачивание Google Pay карты (сохранение в аккаунт Google);
qrcodeUrl - ссылка на qrCode для установки карты. При сканировании кода смартфоном, определяется его ОС и предлагается к скачиванию соответствующая карта;
values - значения переменных карты. Переменные настраиваются в соответствующей вкладке в личном кабинете;
templateId - идентификатор решения (шаблона);
installed - флаг установки карты. True - установлена, false - не установлена;
installedGPay - установка карты в Google Pay. Если > 0, то карта установлена в Google Pay;
installedAW -  установка карты в Apple Wallet. Если > 0, то карта установлена в Apple Wallet;" %}

```
{
	"result": {
		"cardId": "CARD_ID",
		"cardCode":"CARD_CODE",
		"cardUrl": "CARD_URL",
        "appleUrl": "Apple_Wallet_CARD_URL",
        "googleUrl": "Google_Pay_CARD_URL",
		"qrcodeUrl": "QR_CODE_URL",
		"values":{
	    "%VALUE_NAME%": "VALUE_VALUE1"
		}
		"deviceRegistered":false,
		"expirationDate": "",
        "voided": 0,
        "phoneNumber": "MY_PHONE_NUMBER",
        "email": "MY_EMAIL",
        "strip": "",
        "logo": "",
        "icon": "",
        "templateId": "TEMPLATE_ID",
        "importUid": "",
        "installedGPay": 0,
        "installedAW": 0,
        "installed": false,
        "created": "CREATED_DATE",
        "updated": "UPDATED_DATE"
	        },
	"message": "OK",
	"code": 200,
	"error": false
}
```

{% endtab %}
{% endtabs %}

## getCard

<mark style="color:green;">`POST`</mark> `https://getpass.passteam.ru/oapi/v1/getcard`

Поиск карты по значению переменной&#x20;

#### Request Body

| Name             | Type   | Description                                                                                                     |
| ---------------- | ------ | --------------------------------------------------------------------------------------------------------------- |
| templateId       | string | Идентификатор шаблона. Обязательно при поиске карты по cardCode или values.                                     |
| values\[%value%] | string | Переменная и ее значение, с помощью которого будет производится поиск карты, например, \[%PHONE%]=+71234567890. |

{% tabs %}
{% tab title="200 cardId - идентификатор карты в системе;
cardCode - номер карты в решении. Формируется автоматически начиная с 000000001;
cardUrl - ссылка на скачивание карты. Определяет ОС устройства и предлагает установить соответствующую карту;
appleUrl - ссылка на скачивание Apple Wallet карты (pkpass файл);
googleUrl - ссылка на скачивание Google Pay карты (сохранение в аккаунт Google);
qrcodeUrl - ссылка на qrCode для установки карты. При сканировании кода смартфоном, определяется его ОС и предлагается к скачиванию соответствующая карта;
values - значения переменных карты. Переменные настраиваются в соответствующей вкладке в личном кабинете;
templateId - идентификатор решения (шаблона);
installed - флаг установки карты. True - установлена, false - не установлена;
installedGPay - установка карты в Google Pay. Если > 0, то карта установлена в Google Pay;
installedAW - установка карты в Apple Wallet. Если > 0, то карта установлена в Apple Wallet;" %}

```
{
	"result": {
		"cardId": "CARD_ID",
		"cardCode":"CARD_CODE",
		"cardUrl": "CARD_URL",
        "appleUrl": "Apple_Wallet_CARD_URL",
        "googleUrl": "Google_Pay_CARD_URL",
		"qrcodeUrl": "QR_CODE_URL",
		"values":{
		"PHONE": "71234567890"
		}
		"deviceRegistered":false,
		"expirationDate": "",
        "voided": 0,
        "phoneNumber": "MY_PHONE_NUMBER",
        "email": "MY_EMAIL",
        "strip": "",
        "logo": "",
        "icon": "",
        "templateId": "TEMPLATE_ID",
        "importUid": "",
        "installedGPay": 0,
        "installedAW": 0,
        "installed": false,
        "created": "CREATED_DATE",
        "updated": "UPDATED_DATE"
	        },
	"message": "OK",
	"code": 200,
	"error": false
}
```

{% endtab %}
{% endtabs %}