Взаимодействие с API

Формат запросов

Все данные в запросах к Банку 131 и уведомлениях от Банка передаются методом GET или POST по протоколу HTTP. Параметры сообщения упаковываются в JSON-объект.

Адрес для отправки запросов

Как сформировать

<адрес сервера> + /api/v1.1/ + <адрес для отправки запросов нужного метода>

Адреса серверов

  • Для тестирования https://kyc-stage.bank131.ru/
  • Для реальных операций https://kyc.bank131.ru/

Аутентификация

В заголовках запросов к Банку 131 необходимо передавать идентификатор вашего проекта.

Заголовки

НазваниеОбязательностьТипОписание
X-PARTNER-PROJECT+stringИдентификатор проекта. Выдается менеджером Банка 131

Пример запроса с аутентификацией

curl -X GET \
  https://kyc-stage.bank131.ru/api/v1.1/check/7 \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-PROJECT: your_project_name' \
  -d '{
    // тело запроса
}'
 

Подпись запросов

В запросах на проверку отправляются персональные данные, поэтому требуется подписывать запросы с помощью КриптоПро.

Шаг 1. Создайте файл для подписи

Возьмите тело запроса (содержимое payload), отсортируйте по ключам и запишите в файл. Используйте кодировку UTF-8.

Пример

import json

payload = {...}

payload_bytes = bytes(json.dumps(payload, sort_keys=True) + '\r\n', encoding='utf-8')

with open('payload_bytes.jsonb', 'wb') as f:
    f.write(payload_bytes)

Шаг 2. Подпишите файл

Подпишите файл средствами КриптоПро.

Пример создания подписи с помощью cryptcp

cryptcp -encr -thumbprint a2963503c955a34c8a5f7d4abf5e08874827a3aa -thumbprint 5567d04803d51080cec4aa030ff0ef6e26fe7740 -uMy -der bank131_20200903.txt.sig bank131_20200903.txt.sig.enc

Шаг 3. Добавьте в запрос подпись

Передайте в запросе получившуюся подпись — в поле signature.

← ВозможностиПроверка паспорта →