> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Проверка трех элементов банковской карты API Инструкция по интеграции

> Identity Authentication 集成指南 - XHuoAPI

В этой статье будет представлена инструкция по интеграции API проверки трех элементов банковской карты, который можно использовать для проверки подлинности и согласованности информации о номере банковской карты, имени и номере удостоверения личности.

## Процесс подачи заявки

Чтобы использовать API, сначала необходимо перейти на соответствующую страницу [API проверки трех элементов банковской карты](https://api.xhuoapi.ai/documents/eb9c6677-68db-4549-a207-41f8a1084634) и подать заявку на соответствующую услугу. После перехода на страницу нажмите кнопку «Acquire», как показано на изображении:

![](https://cdn.xhuoapi.ai/q6ytrc.png)

Если вы еще не вошли в систему или не зарегистрированы, вас автоматически перенаправит на страницу входа, где вас пригласят зарегистрироваться и войти. После регистрации и входа вы автоматически вернетесь на текущую страницу.

При первой подаче заявки будет предоставлен бесплатный лимит, который можно использовать для бесплатного доступа к этому API.

## Основное использование

Сначала ознакомьтесь с основным способом использования, который заключается в вводе информации о номере банковской карты, после чего вы получите обработанное изображение результата. Сначала необходимо просто передать поле `bank_card`. Далее мы можем заполнить соответствующие данные на интерфейсе, как показано на изображении:

<p>
  <img src="https://cdn.xhuoapi.ai/3kh6i2.png" width="500" className="m-auto" />
</p>

Как видно, здесь мы настроили заголовки запроса, включая:

* `accept`: формат ответа, который вы хотите получить, здесь указано `application/json`, то есть формат JSON.
* `authorization`: ключ для вызова API, который можно выбрать из выпадающего списка после подачи заявки.

Также настроено тело запроса, включая:

* `bank_card`: информация о номере банковской карты, обязательный параметр.
* `id_card`: номер удостоверения личности, обязательный параметр.
* `name`: имя пользователя, обязательный параметр.
* `cert_type`: тип удостоверения личности, который должен соответствовать удостоверению, иначе проверка не пройдет.
* `encryption`: необязательный параметр, параметр шифрования для чувствительных данных (если необходимо отправить зашифрованные данные).

После выбора можно заметить, что справа также сгенерирован соответствующий код, как показано на изображении:

<p>
  <img src="https://cdn.xhuoapi.ai/cpvguu.png" width="500" className="m-auto" />
</p>

Нажмите кнопку «Try», чтобы провести тестирование, как показано на изображении, и мы получили следующий результат:

```json theme={null}
{
  "result": "0",
  "description": "Аутентификация пройдена"
}
```

Возвращаемый результат содержит несколько полей, описание которых приведено ниже:

* `result`, код результата аутентификации, условия оплаты следующие.
  * Код результата оплаты:
    * 0: Аутентификация пройдена
    * -1: Аутентификация не пройдена
    * -4: Ошибка информации о держателе карты
    * -5: Неактивированная безкарточная оплата
    * -6: Эта карта была изъята
    * -7: Неверный номер карты
    * -8: У этой карты нет соответствующего эмитента
    * -9: Эта карта не инициализирована или спящая карта
    * -10: Карта мошенничества, захваченная карта
    * -11: Эта карта была утеряна
    * -12: Эта карта истекла
    * -13: Ограниченная карта
    * -14: Превышено количество неверных попыток пароля
    * -15: Эмитент карты не поддерживает эту транзакцию
  * Код без оплаты:
    * -2: Проверка имени не пройдена
    * -3: Неверный номер банковской карты
    * -16: Служба проверки занята
    * -17: Превышено количество проверок, попробуйте снова на следующий день
* `description`, описание бизнес-результата.

Можно увидеть, что подлинность и согласованность информации о номере банковской карты, имени и номере удостоверения личности прошли проверку.

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

```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/identity/bankcard/check-3e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "bank_card": "***",
  "id_card": "***"
}'
```

Код интеграции на Python выглядит следующим образом:

```python theme={null}
import requests

url = "https://api.xhuoapi.ai/v1/identity/bankcard/check-3e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "name": "***",
    "bank_card": "***",
    "id_card": "***"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
```

## Обработка ошибок

При вызове API, если возникнет ошибка, API вернет соответствующий код ошибки и информацию. Например:

* `400 token_mismatched`: Неверный запрос, возможно, из-за отсутствующих или недействительных параметров.
* `400 api_not_implemented`: Неверный запрос, возможно, из-за отсутствующих или недействительных параметров.
* `401 invalid_token`: Неавторизовано, недействительный или отсутствующий токен авторизации.
* `429 too_many_requests`: Слишком много запросов, вы превысили лимит.
* `500 api_error`: Внутренняя ошибка сервера, что-то пошло не так на сервере.

### Пример ответа об ошибке

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "не удалось получить данные"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## Заключение

С помощью этого документа вы узнали, как использовать API проверки трех элементов банковской карты для проверки подлинности и согласованности информации о номере банковской карты, имени и номере удостоверения личности. Надеемся, что этот документ поможет вам лучше интегрировать и использовать этот API. Если у вас есть какие-либо вопросы, пожалуйста, не стесняйтесь обращаться в нашу техническую поддержку.