Tapaya
Прийом платежів у торговій точціПосібник з інтеграціїІнтеграція через API

Інтеграція через API

Автентифікуйте мерчантів для Accept SDK зі свого бекенда.

Щоб ваші мерчанти могли користуватися Tapaya Accept SDK, ваш бекенд реєструє кожного мерчанта й запитує короткоживучий токен входу для кожної сесії SDK. Обидва виклики використовують ваш Server Secret Token; як його згенерувати, описано в розділі Автентифікація в Platform API.

Онбординг мерчантів і отримання платіжних даних працюють однаково для всіх продуктів Tapaya й описані у спільному розділі «Огляд»: API для онбордингу мерчантів та Звітність і платежі.

Маршрутизація за середовищем

Accept SDK автоматично маршрутизує запити залежно від того, як його було ініціалізовано:

  • Пісочниця (sandbox, за замовчуванням): підключається до середовища пісочниці за адресою https://api.sandbox.tapaya.com.
  • Робоче середовище: підключається до робочого середовища за адресою https://api.tapaya.com.

Автентифікація мерчантів (інтеграції через Accept SDK)

Лише для інтеграцій через Accept SDK

Пропустіть цей розділ, якщо ви керуєте застосунком Tapaya Terminal напряму (intent/deeplink, без вбудованого SDK); тоді мерчантом, відповідальним за транзакцію (merchant of record), є обліковий запис, у який виконано вхід у Tapaya Terminal, і ваш бекенд ніколи не автентифікує сесію мерчанта. Див. Інтеграція без SDK.

Щоб ваші мерчанти могли користуватися Tapaya Accept SDK, ви маєте реалізувати на своєму бекенді такі ендпоінти.

Реєстрація нового мерчанта

Перш ніж мерчант зможе користуватися SDK, його потрібно зареєструвати в системі Tapaya. Зазвичай це робиться тоді, коли користувач реєструється у вашому сервісі. Мерчанта достатньо зареєструвати один раз. Зареєструвати його можна в Tapaya Platform UI або через API.

Ендпоінт: POST /merchant/auth/register

curl -X 'POST' 'https://api.tapaya.com/merchant/auth/register' \
-H 'Content-Type: application/json' \
-H 'Authorization: REPLACE_ME' \
-d '{
        "merchantToken": "unique_merchant_id_from_your_db",
        "merchantName": "Acme Corp",
        "email": "admin@acme.com"
    }'

Параметри:

ПолеТипОбов'язковеОпис
merchantTokenstringУнікальний і незмінний ідентифікатор із вашої системи (наприклад, ID у базі даних), який ідентифікує
мерчанта. Якщо його не вказано, для вас буде згенеровано випадковий токен.
merchantNamestringЗрозуміла людині назва, за якою мерчанта можна впізнати на панелі керування та у звітах. Якщо її не вказано,
використовується merchantToken.
emailstring✓Електронна адреса адміністратора мерчанта, що використовується для входу та важливих повідомлень.

Відповіді:

КодОпис
200Мерчанта успішно зареєстровано
400Помилка валідації запиту
401Неавторизовано
409Конфлікт: мерчанта вже зареєстровано

Тіло відповіді:

{
    "merchantToken": "unique_merchant_id_from_your_db"
}

Генерування токена входу

Щоб мобільний пристрій міг ініціалізувати SDK для конкретного мерчанта, ви маєте згенерувати короткоживучий токен входу. Ваш мобільний застосунок запитує його у вашого бекенда, а ваш бекенд запитує його в Tapaya. Новий токен потрібен щоразу, коли SDK ініціалізується.

Ендпоінт: POST /merchant/auth/login

curl -X 'POST' 'https://api.tapaya.com/merchant/auth/login' \
-H 'Content-Type: application/json' \
-H 'Authorization: REPLACE_ME' \
-d '{
        "merchantToken": "unique_merchant_id_from_your_db",
        "allowOnboarding": true,
        "employeeEmail": "john@acme.com"
    }'

Параметри:

ПолеТипОбов'язковеОпис
merchantTokenstring✓Ідентифікатор мерчанта в системі інтегратора, для якого буде видано токен
автентифікації. Той самий, що й у /auth/register.
allowOnboardingbooleantrue, якщо користувач може від імені мерчанта переглядати й оновлювати дані онбордингу/KYB, підключати нові
способи оплати та приймати умови використання. Під час першого виклику має бути true, щоб мерчант міг
підключити щонайменше один спосіб оплати. false, якщо користувачеві заборонено доступ до онбордингу і він може використовувати лише
вже налаштовані способи оплати. Значення за замовчуванням: true.
employeeEmailstringЕлектронна адреса працівника, який користується терміналом.

Відповіді:

КодОпис
200Мерчант успішно увійшов
400Помилка валідації запиту
401Неавторизовано
404Не знайдено

Тіло відповіді:

{
    "token": "EesrFq4PUK1WxHUj93hkrKASDFp8GxJ0"
}

Передайте цей token своєму мобільному застосунку, щоб ініціалізувати SDK. Передавайте його в мобільний застосунок у захищений спосіб і видаляйте одразу після використання. Токен прив'язаний до мерчанта, ідентифікованого за merchantToken.

Попередження щодо безпеки

Переконайтеся, що під час отримання токена для SDK ви використовуєте правильний merchantToken. Tapaya SDK використовує цей токен, щоб увійти від імені мерчанта, отримуючи доступ до його даних і коштів.

Чогось бракує на цій сторінці?Надішліть запит на функцію. Ми додамо цю сторінку, щоб команда бачила контекст.