Platform API
Prostredia, autentifikácia a sekcie Tapaya Platform API, ktoré vaša integrácia potrebuje.
Tapaya Platform API vám umožňuje spravovať obchodníkov, platby a nastavenia organizácie z vášho servera. Ktoré endpointy potrebujete, závisí od toho, ako vaša aplikácia prijíma platby; nie každý integrátor potrebuje všetky sekcie.
Swagger documentationTapaya Integrator APIEvery endpoint, request field, and enum value, with a console to try requests.Open the API reference
Výčtové hodnoty sú číselné
Polia ako businessTypeId, countryId, currencyId, documentType a refundReasonId sú všetky číselné
výčty (enums). Možné hodnoty pre každé z nich nájdete v
dokumentácii Swagger, nie v tomto sprievodcovi.
Ktoré sekcie sa vás týkajú
| Vaša integrácia | Autentifikácia obchodníkov | Onboarding obchodníkov | Reporting a platby |
|---|---|---|---|
| Accept SDK (vložené do vašej aplikácie) | 🟢 Povinné | 🟡 Voliteľné | 🟡 Voliteľné |
| Iba aplikácia Tapaya Terminal (intent/deeplink, bez SDK) | ⚪ Nie je potrebné | 🟡 Voliteľné | 🟡 Voliteľné |
| Iba reporting / back office | ⚪ Nie je potrebné | ⚪ Nie je potrebné | 🟢 Povinné |
- Autentifikácia obchodníkov: SDK sa autentifikuje ako obchodník pomocou prihlasovacieho tokenu, ktorý si vyžiada váš backend. Pri integráciách s Tapaya Terminal nie je potrebné: obchodník sa prihlasuje priamo do aplikácie Tapaya Terminal, takže neexistuje žiadna relácia SDK, ktorú by váš backend musel autentifikovať.
- Onboarding obchodníkov: voliteľný pre každú platobnú integráciu, v predajni aj online. Obchodník prejde onboardingom raz a tento onboarding pokrýva oba kanály. Onboarding prebieha cez Tapaya Platform UI, hostovanú pozvánku alebo API, podľa toho, kto má údaje obchodníka zhromažďovať.
- Reporting a platby: voliteľné pre ktorúkoľvek platobnú integráciu, ak si budujete vlastné dashboardy; povinné (a samo osebe postačujúce), ak iba sťahujete dáta na reporting a nemáte vlastnú platobnú integráciu.
Všetky riadky stále vyžadujú autentifikáciu pomocou tokenu Server Secret Token.
Použitie Secret key pre Checkout
Online Checkout prijíma ten istý Secret key zo
stránky API Keys, tu nazývaný Server Secret Token.
Checkout vyžaduje Authorization: Bearer <secret-key> a organizáciu priradí k obchodníkovi.
Požiadavky na priradenie obchodníka nájdete v časti Autentifikácia Checkoutu.
Prostredia
Tapaya Platform API podporuje tieto prostredia:
- Produkcia: Beží na
https://api.tapaya.com. Toto prostredie používa skutočné účty a pracuje so skutočnými prostriedkami. Produkčné prostredie nepoužívajte na testovanie. - Sandbox: Beží na
https://api.sandbox.tapaya.com. Toto prostredie vám umožňuje testovať integráciu bez akéhokoľvek pohybu skutočných prostriedkov. Viac o testovaní nájdete v našom sprievodcovi testovaním / sandboxom.
Autentifikácia
Požiadavky na Platform API používajú váš Server Secret Token, na stránke API Keys označený ako Secret key. Odovzdávajte ho bez zmeny v hlavičke Authorization svojich HTTP požiadaviek.
Authorization: REPLACE_MEAby ste svoju platformu voči API autentifikovali, musíte na stránke API Keys vygenerovať Secret key, tu označovaný ako Server Secret Token, a nahradiť ním REPLACE_ME vyššie.
Bezpečnostné upozornenie
Váš Server Secret Token má vysoké oprávnenia. Nikdy ho nezverejňujte v kóde na strane klienta (mobilné aplikácie, webové prehliadače). Smie sa používať iba z vašich zabezpečených backendových serverov.
Ak je token kompromitovaný, zrušte ho na stránke API Keys; zrušenie platí okamžite a nemožno ho vrátiť späť. Náhradný token vygenerujte pred zrušením alebo po ňom, podľa potreby; akcia „rotácie“ tokenu na mieste neexistuje, takže keď nový token vytvoríte, aktualizujte ním konfiguráciu svojho backendu.
Bez obmedzenia rozsahu kľúčov
Každý Server Secret Token má rovnaké oprávnenia v rámci celej organizácie; tokeny zatiaľ nemožno obmedziť na konkrétne endpointy alebo obchodníkov. Každý token považujte za ekvivalent plného prístupu k API pre vašu organizáciu.
Server je dostupný iba cez protokol HTTPS, pričom na úrovni infraštruktúry je vynútený TLS 1.2 alebo novší. Platí obmedzenie počtu požiadaviek (100 požiadaviek za minútu na IP adresu); požiadavky, ktoré server preťažujú, vrátia chybu 429 Too Many Requests.