Przejdź do głównej treści
W niniejszym dokumencie przedstawiono sposób integracji API weryfikacji trzech elementów numeru telefonu, które można wykorzystać do weryfikacji autentyczności i zgodności numeru telefonu, imienia i nazwiska oraz numeru dowodu osobistego.

​
Proces aplikacji

Aby skorzystać z API, należy najpierw przejść do odpowiedniej strony API weryfikacji trzech elementów 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 przyznawana jest darmowa pula, która 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 phone. Następnie możemy wypełnić odpowiednie pola na interfejsie, jak pokazano na obrazku:

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, który można bezpośrednio wybrać z rozwijanej listy po złożeniu wniosku.
Dodatkowo ustawiono ciało żądania, w tym:
  • name: imię i nazwisko użytkownika do przetworzenia, jest to parametr wymagany.
  • phone: numer telefonu do przetworzenia, jest to parametr wymagany.
  • id_card: numer dowodu osobistego użytkownika do przetworzenia, jest to parametr wymagany.
  • verify_mode: tryb weryfikacji (długi/krótki).
  • encrypt_list/ciphertext_blob/iv: opcjonalne parametry szyfrowania, szyfruj pola wrażliwe w razie potrzeby.
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, a otrzymasz następujący wynik: 
{
  "result": "0",
  "description": "Certyfikacja zakończona sukcesem",
  "isp": "Mobilny",
  "result_detail": null
}
Zwracany wynik zawiera wiele pól, które są opisane poniżej:
  • result, kod wyniku certyfikacji, sytuacja dotycząca opłat jest następująca.
    • 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 jest nieprawidłowy
      • -6: Liczba certyfikacji przekracza dzienny limit, spróbuj ponownie następnego dnia
  • description, opis wyniku biznesowego.
Można zauważyć, że informacje o autentyczności i zgodności numeru telefonu, imienia i nazwiska oraz numeru dowodu osobistego zostały już sprawdzone. 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: 
curl -X POST 'https://api.acedata.cloud/identity/phone/check-3e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "phone": "***",
  "id_card": "***"
}'
Kod do integracji w Pythonie wygląda następująco: 
import requests

url = "https://api.acedata.cloud/identity/phone/check-3e"

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

payload = {
    "name": "***",
    "phone": "***",
    "id_card": "***"
}

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

{
  "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 trzech elementów numeru telefonu do weryfikacji autentyczności i zgodności numeru telefonu, imienia i nazwiska oraz numeru 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.