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

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

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

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

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

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

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

url = "https://api.acedata.cloud/identity/bankcard/check-1e"

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

payload = {
    "bank_card": "****"
}

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