Перейти до основного вмісту
У цьому документі буде представлено опис інтеграції API для перевірки статусу номера телефону, який можна використовувати для перевірки статусу номера телефону, ви можете ввести номер телефону для запиту.

​
Процес подачі заявки

Щоб використовувати API, спочатку потрібно перейти на відповідну сторінку API перевірки статусу номера телефону для подачі заявки на відповідну послугу, після переходу на сторінку натисніть кнопку «Acquire», як показано на малюнку: Якщо ви ще не увійшли в систему або не зареєстровані, вас автоматично перенаправлять на сторінку входу, запрошуючи вас зареєструватися та увійти, після входу або реєстрації ви автоматично повернетеся на поточну сторінку. При першій подачі заявки буде надано безкоштовний ліміт, який дозволяє безкоштовно використовувати цей API.

​
Основне використання

Спочатку потрібно ознайомитися з основним способом використання, тобто ввести номер телефону, щоб отримати оброблений результат, спочатку потрібно просто передати поле mobile. Далі ми можемо заповнити відповідні дані на інтерфейсі, як показано на малюнку:

Ми можемо бачити, що тут ми налаштували заголовки запиту, включаючи:
  • accept: вкажіть, у якому форматі ви хочете отримати відповідь, тут вказано application/json, тобто формат JSON.
  • authorization: ключ для виклику API, після подачі заявки ви можете вибрати його зі списку.
Також налаштовано тіло запиту, яке включає:
  • mobile: номер телефону, який потрібно обробити, є обов’язковим параметром.
  • encryption: необов’язковий параметр для шифрування чутливих даних (якщо потрібно передати зашифровані дані).
Після вибору ви можете помітити, що праворуч також згенерувався відповідний код, як показано на малюнку:

Натисніть кнопку «Try», щоб провести тестування, як показано на малюнку, тут ми отримали наступний результат: 
{
  "result": "0",
  "description": "Успішно",
  "status_code": 0
}
Повернене значення містить кілька полів, описаних нижче:
  • result, код результату аутентифікації, умови оплати такі:
    • Код результату з оплатою:
      • 0: успішно
    • Код результату без оплати:
      • -1: результат не знайдено
      • -2: формат номера телефону неправильний
      • -3: служба перевірки зайнята
  • description, опис бізнес-результату.
  • status_code, код статусу:
    • 0: нормально
    • 1: вимкнено
    • 2: номер скасовано
    • 3: порожній номер
    • 4: не в мережі
    • 99: невідомий статус
Можна побачити, що статус цього номера телефону вже перевірено. Крім того, якщо ви хочете згенерувати відповідний код інтеграції, ви можете просто скопіювати його, наприклад, код CURL виглядає так: 
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": "***"
}'
Код інтеграції на Python виглядає так: 
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)

​
Обробка помилок

При виклику API, якщо виникає помилка, API поверне відповідний код помилки та інформацію. Наприклад:
  • 400 token_mismatched: Неправильний запит, можливо, через відсутні або недійсні параметри.
  • 400 api_not_implemented: Неправильний запит, можливо, через відсутні або недійсні параметри.
  • 401 invalid_token: Неавторизовано, недійсний або відсутній токен авторизації.
  • 429 too_many_requests: Занадто багато запитів, ви перевищили ліміт запитів.
  • 500 api_error: Внутрішня помилка сервера, щось пішло не так на сервері.

​
Приклад відповіді з помилкою

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "не вдалося отримати"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Висновок

Завдяки цьому документу ви дізналися, як використовувати API перевірки статусу номера телефону для перевірки статусу номера телефону, ви можете ввести номер телефону для запиту. Сподіваємося, цей документ допоможе вам краще інтегрувати та використовувати цей API. Якщо у вас є будь-які питання, будь ласка, звертайтеся до нашої команди технічної підтримки.