> ## 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/667017a4-017f-4af0-870e-807034f70632) и подать заявку на соответствующую услугу. После перехода на страницу нажмите кнопку «Acquire», как показано на изображении:

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

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

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

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

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

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

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

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

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

* `name`: имя.
* `id_card`: номер удостоверения личности.
* `image_url`: ссылка на изображение лица, которое нужно обработать.
* `validity_end`: дата окончания срока действия удостоверения личности, формат: YYYYMMDD, для долгосрочного использования укажите «00000000»;
* `validity_begin`: дата начала срока действия удостоверения личности, формат: YYYYMMDD.
* `encryption`: необязательный параметр для шифрования чувствительных данных (если необходимо отправить зашифрованные данные).

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

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

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

```json theme={null}
{
  "result": "0",
  "description": "一致"
}
```

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

* `result`, код результата проверки, условия оплаты следующие.
  * Код результата с оплатой:
    * 0: Имя и номер удостоверения личности совпадают
    * -1: Имя и номер удостоверения личности не совпадают
  * Код результата без оплаты:
    * -2: Неверный номер удостоверения личности (длина, контрольная цифра и т.д. некорректны)
    * -3: Неверное имя (длина, формат и т.д. некорректны)
    * -4: Ошибка службы базы данных удостоверений
    * -5: В базе данных удостоверений нет записи с этим номером удостоверения
    * -6: Система авторитетного сопоставления обновляется, пожалуйста, попробуйте позже
    * -7: Превышено количество проверок за день.
* `description`, результат проверки имени и номера удостоверения личности.

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

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

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

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

```python theme={null}
import requests

url = "https://api.xhuoapi.ai/v1/identity/idcard/check-2e"

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

payload = {
    "name": "***",
    "id_card": "***",
    "validity_begin": "***",
    "validity_end": "***"
}

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": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

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

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