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

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

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

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

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

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

Натисніть кнопку «Try», щоб провести тестування, як показано на малюнку, тут ми отримали наступний результат: 
{
  "result": "0",
  "description": "Результат перевірки узгоджений"
}
Повернені результати містять кілька полів, описаних нижче:
  • result, код результату сертифікації, умови оплати такі:
    • Коди результату з оплатою:
      • 0: Результат перевірки узгоджений
      • 1: Результат перевірки неузгоджений
    • Коди результату без оплати:
      • -1: Запис не знайдено
      • -2: Невідома помилка двигуна
      • -3: Аномалія сервісу двигуна
      • -4: Перевірка імені не пройшла
      • -5: Номер телефону недійсний
      • -6: Кількість сертифікацій перевищує добове обмеження, будь ласка, спробуйте наступного дня
  • description, опис бізнес-результату.
Можна побачити, що достовірність та узгодженість номера телефону та імені вже перевірено. Крім того, якщо ви хочете згенерувати відповідний код інтеграції, ви можете просто скопіювати його, наприклад, код CURL виглядає так: 
curl -X POST 'https://api.acedata.cloud/identity/phone/check-2e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "mobile": "***"
}'
Код інтеграції на Python виглядає так: 
import requests

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

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

При виклику 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. Якщо у вас є будь-які питання, будь ласка, звертайтеся до нашої команди технічної підтримки.