Przejdź do głównej treści

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.

Niniejszy dokument przedstawia sposób integracji API do sprawdzania statusu numeru telefonu, które można wykorzystać do weryfikacji statusu numeru telefonu. Możesz wprowadzić numer telefonu, aby przeprowadzić zapytanie.

​
Proces aplikacji

Aby skorzystać z API, należy najpierw przejść do strony API do sprawdzania statusu numeru telefonu i złożyć wniosek o odpowiednią usługę. Po wejściu na stronę kliknij przycisk „Acquire”, jak pokazano na obrazku: 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. Należy najpierw przekazać prosty parametr mobile. Następnie możemy wypełnić odpowiednie pola na interfejsie, jak pokazano na obrazku:

Możemy zobaczyć, że ustawiliśmy nagłówki żądania, w tym:
  • accept: format odpowiedzi, który chcemy otrzymać, tutaj wpisujemy 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:
  • 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:

Kliknij przycisk „Try”, aby przeprowadzić test, jak pokazano na powyższym obrazku, tutaj uzyskaliśmy następujący wynik: 
{
  "result": "0",
  "description": "Sukces",
  "status_code": 0
}
Zwrócony wynik zawiera wiele pól, które są opisane poniżej:
  • result, kod wyniku weryfikacji, sytuacja dotycząca opłat jest następująca.
    • Kody wyników płatnych:
      • 0: Sukces
    • Kody wyników bezpłatnych:
      • -1: Nie znaleziono wyniku
      • -2: Nieprawidłowy format numeru telefonu
      • -3: Centrum weryfikacji jest zajęte
  • description, opis wyniku biznesowego.
  • status_code, kod statusu:
    • 0: Normalny
    • 1: Zawieszenie
    • 2: Anulowanie numeru
    • 3: Pusty numer
    • 4: Nie w sieci
    • 99: Nieznany status
Można zauważyć, że status tego numeru telefonu został już sprawdzony. Dodatkowo, jeśli chcesz wygenerować odpowiedni kod integracyjny, możesz go bezpośrednio skopiować, na przykład kod CURL wygląda następująco: 
curl -X POST 'https://api.xhuoapi.ai/v1/identity/phone/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "mobile": "***"
}'
Kod integracyjny w Pythonie wygląda następująco: 
import requests

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

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

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

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

​
Obsługa błędów

Podczas wywoływania API, jeśli napotkasz 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

{
  "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 do sprawdzania statusu numeru telefonu w celu weryfikacji statusu numeru telefonu. Możesz wprowadzić numer telefonu, aby przeprowadzić zapytanie. 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.