Opis integracji API do sprawdzania statusu numeru telefonu

​

Proces aplikacji

📘 Pełna dokumentacja: API do sprawdzania statusu numeru telefonu →

​

Podstawowe użycie

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

• 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).

{
  "result": "0",
  "description": "Sukces",
  "status_code": 0
}

• 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: Usługa centrum weryfikacji jest zajęta
• 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

curl -X POST 'https://api.acedata.cloud/identity/phone/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "mobile": "***"
}'

import requests

url = "https://api.acedata.cloud/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

• 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 autoryzacji.
• 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