Партнерам| Подключение продуктов

Схема взаимодействия

Авторизация

Авторизация запроса происходит путем формирования и передачи JWS токена запроса в заголовке X-JWS-Signature. JWS это часть токена JWT, которая содержит только header и signature.

Формат передаваемых данных application/json.

Пример формирования подписи

Тело запроса:

{
    "request_id": "828cf71d-a447-4a67-a149-c1df8bc197ca",
    "name": "Название юридического лица",
    "bin": 123456789012,
    "ceo_info": {
        "first_name": "Имя",
        "last_name": "Фамилия",
        "phone": 77017777777,
        "email": "mail@example.kz"
    },
    "address_info": {
        "country": "KZ",
        "postal_code": "050000",
        "address_line1": "Almaty",
        "address_line2": "Zheltoksan",
        "address_line3": "115" 
    },
    "iban": "KZ12345B789012345KZT",
    "description": "Новый партнер"
}

Заголовок JWT токена:

{
    "uri": "/v5/partner/client/add",
    "auth_id": "123456",
    "method": "POST",
    "params": "",
    "alg": "HS256"
}

Ключ партнера может быть secret_key. В этом случае может быть сформирован следующий JWT токен:

eyJ1cmkiOiIvdjUvcGFydG5lci9jbGllbnQvYWRkIiwiYXV0aF9pZCI6IjEyMzQ1NiIsIm1ldGhvZCI6IlBPU1QiLCJwYXJhbXMiOiIiLCJhbGciOiJIUzI1NiJ9.eyJyZXF1ZXN0X2lkIjoiODI4Y2Y3MWQtYTQ0Ny00YTY3LWExNDktYzFkZjhiYzE5N2NhIiwibmFtZSI6ItCd0LDQt9Cy0LDQvdC40LUg0Y7RgNC40LTQuNGH0LXRgdC60L7Qs9C-INC70LjRhtCwIiwiYmluIjoxMjM0NTY3ODkwMTIsImNlb19pbmZvIjp7ImZpcnN0X25hbWUiOiLQmNC80Y8iLCJsYXN0X25hbWUiOiLQpNCw0LzQuNC70LjRjyIsInBob25lIjo3NzAxNzc3Nzc3NywiZW1haWwiOiJtYWlsQGV4YW1wbGUua3oifSwiYWRkcmVzc19pbmZvIjp7ImNvdW50cnkiOiJLWiIsInBvc3RhbF9jb2RlIjoiMDUwMDAwIiwiYWRkcmVzc19saW5lMSI6IkFsbWF0eSIsImFkZHJlc3NfbGluZTIiOiJaaGVsdG9rc2FuIiwiYWRkcmVzc19saW5lMyI6IjExNSJ9LCJpYmFuIjoiS1oxMjM0NUI3ODkwMTIzNDVLWlQiLCJkZXNjcmlwdGlvbiI6ItCd0L7QstGL0Lkg0L_QsNGA0YLQvdC10YAifQ.HR6MSeTvX6MFbug2619WEUf2TyoQTi9XUKVU4QtXNAQ

Эта строка является подписью запроса и должна быть передана в параметре заголовка запроса X-JWS-Signature.

eyJ1cmkiOiIvdjUvcGFydG5lci9jbGllbnQvYWRkIiwiYXV0aF9pZCI6IjEyMzQ1NiIsIm1ldGhvZCI6IlBPU1QiLCJwYXJhbXMiOiIiLCJhbGciOiJIUzI1NiJ9..HR6MSeTvX6MFbug2619WEUf2TyoQTi9XUKVU4QtXNAQ

Поддерживаемый алгоритм шифрования подписи HS256.

Добавление пользователя

Метод предоставляет партнерам возможность добавлять пользователей клиента.

Запрос

URL запроса:
POST https://api.freedompay.kz/v5/partner/client/user/add

Ответ:

Подключение продукта

Метод предоставляет партнерам возможность подключать созданным ранее Клиентам различные продукты. Метод содержит обязательные параметры client_id и product*product_id, остальные параметры варьируются в зависимости от подключаемого продукта.

Запрос

URL запроса:
POST https://api.freedompay.kz/v5/partner/client/product/add

Ответ:

Предоставление пользователю доступа к продукту

Метод позволяет партнерам выдавать доступ пользователям клиента к подключенным продуктам клиента.

Запрос

URL запроса:
POST https://api.freedompay.kz/v5/partner/user/product/add

Ответ:

Отправка данных для авторизации

Метод предназначен для отправки логина и пароля для авторизации. Логин и пароль для авторизации высылается на email пользователя. По продукту Soft Pos логин и пароль для авторизации в мобильном приложении высылается по SMS на номер телефона пользователя.

Запрос

URL запроса:
POST https://api.freedompay.kz/v5/partner/user/credential/send

Ответ:

Запрос на создание клиента и подключение продукта

Запрос

URL запроса:
POST https://.../v5/partner/client/add

Ответ

Запрос статуса обработки запроса

Запрос

URL запроса:
POST https://.../v5/partner/client/request/status

Ответ

В случае ошибок, будут дополнительные параметры ответа:

Справочники

Статус запроса

Код продукта

Параметры для подключения продуктов

Freedom Pos

Freedom Ecom

Лимиты для продукта Freedom Ecom