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

# Dokumentacja integracji API weryfikacji zdjęć z dowodu osobistego

> Identity Authentication 集成指南 - XHuoAPI

Niniejszy dokument przedstawia sposób integracji API weryfikacji zdjęć z dowodu osobistego, które może być używane do przesyłania zdjęć twarzy z dowodu osobistego, rozpoznawania informacji na zdjęciu dowodu oraz porównywania imienia, numeru dowodu osobistego i zdjęcia twarzy z autoryzowanym zdjęciem w bazie danych, aby sprawdzić, czy należy do tej samej osoby, co pozwala na weryfikację autentyczności informacji z dowodu osobistego.

## Proces aplikacji

Aby skorzystać z API, należy najpierw przejść do strony [API weryfikacji zdjęć z dowodu osobistego](https://api.xhuoapi.ai/documents/7a3f14f7-f1eb-41c2-816c-9f18caca6883) 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 otrzymasz darmowy limit, który pozwala na bezpłatne korzystanie z tego API.

## Podstawowe użycie

Najpierw zapoznaj się z podstawowym sposobem użycia, czyli wprowadzeniem 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/zjxg3k.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.
* `config`: opcjonalne opcje konfiguracyjne, pole typu boolean, domyślnie wszystkie ustawione na false, wspiera `copy_warn`, `border_check_warn`, `reshoot_warn`, `detect_ps_warn`, `temp_id_warn`, `quality` (próg 0-100).

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/4yh23p.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}
{
  "sim": 99.76,
  "result": "Success",
  "description": "Sukces",
  "name": "Imię na dowodzie",
  "sex": "Płeć na dowodzie",
  "nation": "Narodowość na dowodzie",
  "birth": "Data urodzenia na dowodzie",
  "address": "Adres zamieszkania na dowodzie",
  "id_num": "Numer dowodu",
  "portrait": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBA.....DEhE2lbPMcOtG3f/DLT/yX8if7Kxn/AD7h85wdttPifRf1e6//2Q==",
  "warnings": "",
  "quality": 0,
  "encryption": null
}
```

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

* `sim`, podobieństwo, zakres wartości \[0.00, 100.00]. Zaleca się, aby podobieństwo większe lub równe 70 uznawano za tę samą osobę, można dostosować próg w zależności od konkretnego scenariusza (próg 70 ma wskaźnik błędnych akceptacji na poziomie jednego na tysiąc, próg 80 ma wskaźnik błędnych akceptacji na poziomie jednego na dziesięć tysięcy).
* `result`, kod błędu biznesowego, w przypadku sukcesu zwraca Success, w przypadku błędu proszę odwołać się do poniższej listy kodów błędów w sekcji FailedOperation.
* `description`, wynik weryfikacji imienia i numeru dowodu.
* `name`, informacja o imieniu na dowodzie, jeśli nie przesłano zdjęcia dowodu, będzie pusta.
* `sex`, informacja o płci na dowodzie, jeśli nie przesłano zdjęcia dowodu, będzie pusta.
* `nation`, informacja o narodowości na dowodzie, jeśli nie przesłano zdjęcia dowodu, będzie pusta.
* `birth`, informacja o dacie urodzenia na dowodzie, jeśli nie przesłano zdjęcia dowodu, będzie pusta.
* `address`, informacja o adresie zamieszkania na dowodzie, jeśli nie przesłano zdjęcia dowodu, będzie pusta.
* `id_num`, informacja o numerze dowodu na dowodzie, jeśli nie przesłano zdjęcia dowodu, będzie pusta.
* `portrait`, kodowanie base64 zdjęcia z dowodu, jeśli wycięcie zdjęcia się nie powiedzie, porównywane będzie całe zdjęcie dowodu i zwróci puste.
* `warnings`, informacje o ostrzeżeniach, gdy w konfiguracji ustawiono informacje o ostrzeżeniach, porównanie twarzy zostanie zatrzymane, a wynik zwróci błąd (FailedOperation.OcrWarningOccurred) z tymi informacjami o ostrzeżeniach.
* `quality`, wynik jakości zdjęcia, gdy w konfiguracji żądania ustawiono ostrzeżenie o rozmyciu, ten parametr ma znaczenie, zakres wartości (0-100), obecnie domyślny próg to 50 punktów, poniżej 50 punktów wywoła ostrzeżenie o rozmyciu.
* `encryption`, informacje o szyfrowaniu danych wrażliwych.

Można zauważyć, że informacje z dowodu osobistego mają bardzo wysoką autentyczność.

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/check-1e' \
-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/check-1e"

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)
```

## Obsługa błędów

Podczas wywoływania API, jeśli wystąpi błąd, API zwróci odpowiedni kod błędu i informacje. Na przykład:

* `400 token_mismatched`: Zły wniosek, prawdopodobnie z powodu brakujących lub nieprawidłowych parametrów.
* `400 api_not_implemented`: Zły wniosek, 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": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## Wnioski

Dzięki temu dokumentowi zrozumiałeś, jak używać API weryfikacji zdjęć z dowodu osobistego do przesyłania zdjęć twarzy z dowodu osobistego, rozpoznawania informacji na zdjęciu dowodu oraz porównywania imienia, numeru dowodu osobistego i zdjęcia twarzy z autoryzowanym zdjęciem w bazie danych, aby sprawdzić, czy należy do tej samej osoby, co pozwala na weryfikację autentyczności informacji z dowodu osobistego. 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.
