Tapaya
Přijímání plateb v prodejněPrůvodce integracíIntegrace API

Integrace API

Autentizujte obchodníky pro Accept SDK ze svého backendu.

Aby vaši obchodníci mohli používat Tapaya Accept SDK, váš backend zaregistruje každého obchodníka a pro každou relaci SDK si vyžádá krátkodobý přihlašovací token. Obě volání používají váš Server Secret Token; jak jej vygenerovat, popisuje autentizace v Platform API.

Onboarding obchodníků a stahování platebních dat fungují pro všechny produkty Tapaya stejně a jsou popsány ve sdílené sekci Přehled: API pro onboarding obchodníků a Reporting a platby.

Směrování podle prostředí

Accept SDK automaticky směruje požadavky podle toho, jak bylo inicializováno:

  • Sandbox (výchozí): Připojuje se k sandboxu na adrese https://api.sandbox.tapaya.com.
  • Produkce: Připojuje se k produkčnímu prostředí na adrese https://api.tapaya.com.

Autentizace obchodníků (integrace přes Accept SDK)

Pouze pro integrace přes Accept SDK

Tuto sekci přeskočte, pokud ovládáte aplikaci Tapaya Terminal přímo (intent/deeplink, bez vloženého SDK); obchodníkem odpovědným za transakci (merchant of record) je pak účet přihlášený v Tapaya Terminal a váš backend nikdy neautentizuje relaci obchodníka. Viz Integrace bez SDK.

Aby vaši obchodníci mohli používat Tapaya Accept SDK, musíte na svém backendu implementovat následující endpointy.

Registrace nového obchodníka

Než může obchodník používat SDK, musí být zaregistrován v systému Tapaya. Obvykle se to provádí ve chvíli, kdy se uživatel zaregistruje do vaší služby. Obchodníka stačí zaregistrovat jednou. Registraci lze provést v Tapaya Platform UI nebo pomocí API.

Endpoint: 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"
    }'

Parametry:

PoleTypPovinnéPopis
merchantTokenstringJedinečný a stálý identifikátor z vašeho systému (např. ID v databázi), který identifikuje
obchodníka. Pokud jej neuvedete, vygeneruje se náhodný token.
merchantNamestringČitelný název, podle kterého obchodníka poznáte v dashboardu a reportech. Pokud jej neuvedete,
použije se merchantToken.
emailstring✓E-mail správce obchodníka, používaný pro přihlášení a důležitou komunikaci.

Odpovědi:

KódPopis
200Obchodník byl úspěšně zaregistrován
400Chyba validace požadavku
401Neoprávněný přístup
409Konflikt: obchodník je již zaregistrován

Tělo odpovědi:

{
    "merchantToken": "unique_merchant_id_from_your_db"
}

Vygenerování přihlašovacího tokenu

Aby mobilní zařízení mohlo inicializovat SDK pro konkrétního obchodníka, musíte vygenerovat krátkodobý přihlašovací token. Vaše mobilní aplikace si jej vyžádá od vašeho backendu a váš backend si jej vyžádá od Tapaya. Nový token potřebujete při každé inicializaci SDK.

Endpoint: 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"
    }'

Parametry:

PoleTypPovinnéPopis
merchantTokenstring✓Identifikátor obchodníka u integrátora, pro kterého bude autentizační token
vydán. Stejný jako v /auth/register.
allowOnboardingbooleantrue, pokud uživatel smí za obchodníka zobrazovat a upravovat údaje onboardingu/KYB, registrovat nové
platební metody a schvalovat obchodní podmínky. Při prvním volání musí být true, aby obchodník mohl
zaregistrovat alespoň jednu platební metodu. false, pokud uživatel nemá přístup k onboardingu a může používat pouze
již nakonfigurované platební metody. Výchozí hodnota je true.
employeeEmailstringE-mail zaměstnance, který používá terminál.

Odpovědi:

KódPopis
200Obchodník byl úspěšně přihlášen
400Chyba validace požadavku
401Neoprávněný přístup
404Nenalezeno

Tělo odpovědi:

{
    "token": "EesrFq4PUK1WxHUj93hkrKASDFp8GxJ0"
}

Předejte tento token své mobilní aplikaci, aby mohla SDK inicializovat. Do mobilní aplikace jej přeneste bezpečně a ihned po použití jej smažte. Token je vázán na obchodníka identifikovaného pomocí merchantToken.

Bezpečnostní upozornění

Při získávání tokenu pro SDK se ujistěte, že používáte správný merchantToken. Tapaya SDK tento token používá k přihlášení jménem obchodníka, čímž získává přístup k jeho datům a prostředkům.

Chybí vám něco na této stránce?Navrhněte funkci. Připojíme tuto stránku, aby tým viděl souvislosti.