> ## 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.

# Opis integracji API rozpoznawania dowodu osobistego i weryfikacji informacji

> Identity Authentication 集成指南 - XHuoAPI

Niniejszy dokument przedstawia sposób integracji API rozpoznawania dowodu osobistego i weryfikacji informacji, które umożliwia weryfikację autentyczności i zgodności imienia oraz numeru dowodu osobistego poprzez wprowadzenie zdjęcia dowodu osobistego lub imienia i numeru dowodu osobistego. Interfejs ten służy do weryfikacji autentyczności i zgodności imienia oraz numeru dowodu osobistego, można to zrobić, wprowadzając imię i numer dowodu osobistego lub przesyłając zdjęcie twarzy z dowodu osobistego.

## Proces aplikacji

Aby skorzystać z API, należy najpierw przejść do odpowiedniej strony [API rozpoznawania dowodu osobistego i weryfikacji informacji](https://api.xhuoapi.ai/documents/67f96afa-60b8-4cbb-a4bf-0cbfcf139a23) i złożyć wniosek o odpowiednią usługę. Po wejściu na stronę kliknij przycisk „Acquire”, jak pokazano na obrazku:

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

Jeśli nie jesteś zalogowany lub zarejestrowany, automatycznie zostaniesz przekierowany na stronę logowania, aby zarejestrować się i zalogować. Po zalogowaniu lub rejestracji automatycznie wrócisz na bieżącą stronę.

Podczas pierwszej aplikacji przyznawany jest darmowy limit, który można wykorzystać do korzystania z tego API.

## Podstawowe użycie

Najpierw zapoznaj się z podstawowym sposobem użycia, polegającym na wprowadzeniu linku do zdjęcia dowodu osobistego, aby uzyskać przetworzony wynik weryfikacji. Najpierw musisz przekazać pole `image_url`, a następnie możemy wypełnić odpowiednie treści na interfejsie, jak pokazano na obrazku:

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

Można zauważyć, że ustawiliśmy nagłówki żądania, w tym:

* `accept`: format odpowiedzi, który chcesz otrzymać, tutaj wpisano `application/json`, czyli format JSON.
* `authorization`: klucz do wywołania API, po złożeniu wniosku można go bezpośrednio wybrać z rozwijanej listy.

Dodatkowo ustawiono ciało żądania, w tym:

* `image_url`: link do zdjęcia dowodu osobistego, które ma być przetworzone.
* `encryption`: opcjonalnie, parametr szyfrowania dla wrażliwych pól (jeśli wymagane jest przesłanie zaszyfrowanych danych).

Po dokonaniu wyboru można zauważyć, że po prawej stronie wygenerowano odpowiedni kod, jak pokazano na obrazku:

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

Kliknij przycisk „Try”, aby przeprowadzić test, jak pokazano na powyższym obrazku, a otrzymamy następujący wynik:

```json theme={null}
{
  "result": "0",
  "description": "Imię i numer dowodu osobistego są zgodne",
  "name": "Imię na dowodzie osobistym",
  "id_card": "Numer dowodu osobistego",
  "sex": "Płeć na dowodzie osobistym",
  "nation": "Narodowość na dowodzie osobistym",
  "birth": "Data urodzenia na dowodzie osobistym",
  "address": "Adres zamieszkania na dowodzie osobistym"
}
```

Zwracany wynik zawiera wiele pól, które są opisane poniżej:

* `result`, kod wyniku weryfikacji, szczegóły opłat są następujące.
  * Kody wyników płatnych:
    * 0: Imię i numer dowodu osobistego są zgodne
    * -1: Imię i numer dowodu osobistego są niezgodne
  * Kody wyników bezpłatnych:
    * -2: Nieprawidłowy numer dowodu osobistego (długość, suma kontrolna itp. są niepoprawne)
    * -3: Nieprawidłowe imię (długość, format itp. są niepoprawne)
    * -4: Błąd usługi bazy dokumentów
    * -5: Brak rekordu dowodu osobistego w bazie dokumentów
    * -6: System porównawczy w trakcie aktualizacji, spróbuj ponownie później
    * -7: Liczba weryfikacji przekroczyła dzienny limit.
* `description`, wynik weryfikacji imienia i numeru dowodu osobistego.
* `name`, informacja o imieniu na dowodzie osobistym, jeśli nie przesłano zdjęcia dowodu osobistego, będzie pusta.
* `id_card`, informacja o numerze dowodu osobistego, jeśli nie przesłano zdjęcia dowodu osobistego, będzie pusta.
* `sex`, informacja o płci na dowodzie osobistym, jeśli nie przesłano zdjęcia dowodu osobistego, będzie pusta.
* `nation`, informacja o narodowości na dowodzie osobistym, jeśli nie przesłano zdjęcia dowodu osobistego, będzie pusta.
* `birth`, informacja o dacie urodzenia na dowodzie osobistym, jeśli nie przesłano zdjęcia dowodu osobistego, będzie pusta.
* `address`, informacja o adresie zamieszkania na dowodzie osobistym, jeśli nie przesłano zdjęcia dowodu osobistego, będzie pusta.

Można zauważyć, że informacje o imieniu i numerze dowodu osobistego są zgodne i ważne, a także wykorzystano technologię OCR do wydobycia innych informacji i ich wyświetlenia.

Dodatkowo, jeśli chcesz wygenerować odpowiedni kod do integracji, możesz go bezpośrednio skopiować, na przykład kod CURL wygląda następująco:

```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/identity/idcard/ocr' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "image_url": {image_url}
}'
```

Kod do integracji w Pythonie wygląda następująco:

```python theme={null}
import requests

url = "https://api.xhuoapi.ai/v1/identity/idcard/ocr"

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

payload = {
    "image_url": {image_url}
}

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

## Weryfikacja niestandardowych informacji

Oferujemy również sposób weryfikacji, który nie ujawnia informacji ze zdjęcia dowodu osobistego, można przesłać tylko imię `name` i numer dowodu osobistego `id_card`, aby zweryfikować autentyczność i zgodność imienia oraz numeru dowodu osobistego. Poniżej znajdują się wprowadzone szczegółowe informacje:

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

Po kliknięciu „Uruchom” otrzymujemy następujący wynik:

```json theme={null}
{
    "address": "",
    "birth": "",
    "description": "Imię i numer dowodu osobistego są zgodne",
    "id_card": "Numer dowodu osobistego",
    "name": "Imię na dowodzie osobistym",
    "nation": "",
    "result": "0",
    "sex": ""
 }
```

Z wyników widać, że nie ujawniono innych informacji prywatnych, co również pozwala na weryfikację autentyczności i zgodności imienia oraz numeru dowodu osobistego.

## Obsługa błędów

Podczas wywoływania API, jeśli wystąpią błędy, API zwróci odpowiednie kody błędów i informacje. Na przykład:

* `400 token_mismatched`: Złe żądanie, prawdopodobnie z powodu brakujących lub nieprawidłowych parametrów.
* `400 api_not_implemented`: Złe żądanie, prawdopodobnie z powodu brakujących lub nieprawidłowych parametrów.
* `401 invalid_token`: Nieautoryzowany, nieprawidłowy lub brakujący token autoryzacyjny.
* `429 too_many_requests`: Zbyt wiele żądań, przekroczono limit.
* `500 api_error`: Błąd wewnętrzny serwera, coś poszło nie tak na serwerze.

### Przykład odpowiedzi błędu

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "pobieranie nie powiodło się"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## Wnioski

Dzięki temu dokumentowi zrozumiałeś, jak korzystać z API rozpoznawania dowodu osobistego i weryfikacji informacji do weryfikacji autentyczności i zgodności imienia oraz numeru dowodu osobistego na podstawie przesłanego zdjęcia lub informacji. Mamy nadzieję, że ten dokument pomoże Ci lepiej zintegrować i korzystać z tego API. W razie jakichkolwiek pytań, prosimy o kontakt z naszym zespołem wsparcia technicznego.
