> ## 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 weryfikacji numeru telefonu

> Identity Authentication 集成指南 - XHuoAPI

W niniejszym dokumencie przedstawiono sposób integracji API weryfikacji numeru telefonu, które może być używane do sprawdzania autentyczności i zgodności numeru telefonu oraz imienia i nazwiska.

## Proces aplikacji

Aby skorzystać z API, należy najpierw przejść do odpowiedniej strony [API weryfikacji numeru telefonu](https://api.xhuoapi.ai/documents/1f39c948-6d9b-48f5-83fb-0719da4f6ab0) 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, polegającym na wprowadzeniu numeru telefonu, aby uzyskać przetworzony wynik. Najpierw musisz przekazać prosty parametr `mobile`. Następnie możemy wypełnić odpowiednie pola na interfejsie, jak pokazano na obrazku:

<p>
  <img src="https://cdn.xhuoapi.ai/v6k96j.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:

* `name`: imię i nazwisko użytkownika do przetworzenia, jest to parametr obowiązkowy.
* `mobile`: numer telefonu do przetworzenia, jest to parametr obowiązkowy.
* `encryption`: opcjonalny, parametr szyfrowania dla wrażliwych danych (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/lq800o.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": "Wynik weryfikacji zgodny"
}
```

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: Wynik weryfikacji zgodny
    * 1: Wynik weryfikacji niezgodny
  * Kody wyników bezpłatnych:
    * -1: Brak rekordów
    * -2: Nieznany błąd silnika
    * -3: Nieprawidłowa usługa silnika
    * -4: Weryfikacja imienia i nazwiska nie powiodła się
    * -5: Numer telefonu nieprawidłowy
    * -6: Liczba weryfikacji przekroczyła dzienny limit, spróbuj ponownie następnego dnia
* `description`, opis wyniku biznesowego.

Można zauważyć, że autentyczność i zgodność numeru telefonu oraz imienia i nazwiska zostały sprawdzone.

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/phone/check-2e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "mobile": "***"
}'
```

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

```python theme={null}
import requests

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

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

payload = {
    "name": "***",
    "mobile": "***"
}

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łędy, API zwróci odpowiedni kod błędu 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 weryfikacji numeru telefonu w celu sprawdzenia autentyczności i zgodności numeru telefonu oraz imienia i nazwiska. 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.