# Platform API (/cs/platform-api)





Tapaya Platform API vám umožňuje spravovat obchodníky, platby a nastavení organizace z vašeho serveru. Které
endpointy potřebujete, závisí na tom, jak vaše aplikace přijímá platby; ne každý integrátor potřebuje všechny sekce.

<SwaggerBanner href="https://api.tapaya.com/openapi/index.html" />

<Callout title="Výčtové hodnoty jsou číselné" type="info">
  Pole jako `businessTypeId`, `countryId`, `currencyId`, `documentType` a `refundReasonId` jsou všechna číselné
  výčty (enums). Možné hodnoty pro každé z nich najdete v
  [dokumentaci Swagger](https://api.tapaya.com/openapi/index.html), nikoli v tomto průvodci.
</Callout>

## Které sekce se vás týkají [#which-sections-apply-to-you]

| Vaše integrace                                                                                                                 | [Autentizace obchodníků](/in-store/integration/backend_integration#merchant-authentication-accept-sdk-integrations) | [Onboarding obchodníků](/platform-api/merchant_onboarding) | [Reporting a platby](/platform-api/reporting) |
| ------------------------------------------------------------------------------------------------------------------------------ | :-----------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------: | :-------------------------------------------: |
| **Accept SDK** (vložené do vaší aplikace)                                                                                      |                                                      🟢 Povinné                                                     |                        🟡 Volitelné                        |                  🟡 Volitelné                 |
| **Pouze aplikace Tapaya Terminal** ([intent/deeplink](/in-store/integration/card_terminal#integrate-without-the-sdk), bez SDK) |                                                    ⚪ Není potřeba                                                   |                        🟡 Volitelné                        |                  🟡 Volitelné                 |
| **Pouze reporting / back office**                                                                                              |                                                    ⚪ Není potřeba                                                   |                       ⚪ Není potřeba                       |                   🟢 Povinné                  |

* **Autentizace obchodníků**: SDK se autentizuje jako obchodník pomocí přihlašovacího tokenu, který si vyžádá váš backend. Pro
  integrace s Tapaya Terminal není potřeba: obchodník se přihlašuje přímo do aplikace Tapaya Terminal, takže neexistuje žádná
  relace SDK, kterou by váš backend musel autentizovat.
* **Onboarding obchodníků**: volitelný pro každou platební integraci, v prodejně i online. Obchodník projde onboardingem jednou a
  tento onboarding pokrývá oba kanály. Onboarding probíhá přes Tapaya Platform UI, hostovanou pozvánku nebo API, podle toho,
  kdo má údaje obchodníka shromažďovat.
* **Reporting a platby**: volitelné pro kteroukoli platební integraci, pokud si stavíte vlastní dashboardy;
  povinné (a samo o sobě dostačující), pokud pouze stahujete data pro reporting a nemáte vlastní platební integraci.

Všechny řádky stále vyžadují [autentizaci](#authentication) pomocí tokenu Server Secret Token.

<Callout title="Použití Secret key pro Checkout" type="info">
  [Online Checkout](/online/integration/api_integration#authentication) přijímá stejný **Secret key** ze
  [stránky API Keys](https://platform.tapaya.com/api-keys/), zde nazývaný Server Secret Token.
  Checkout vyžaduje `Authorization: Bearer <secret-key>` a organizaci přiřadí k obchodníkovi.
  Požadavky na přiřazení obchodníka najdete v části [Autentizace Checkoutu](/online/integration/api_integration#authentication).
</Callout>

## Prostředí [#environments]

Tapaya Platform API podporuje následující prostředí:

* **Produkce:** Běží na `https://api.tapaya.com`. Toto prostředí používá skutečné účty a pracuje se skutečnými prostředky. &#x2A;*Produkční prostředí nepoužívejte k testování.**
* **Sandbox:** Běží na `https://api.sandbox.tapaya.com`. Toto prostředí vám umožňuje testovat integraci bez jakéhokoli pohybu skutečných prostředků. Více o testování najdete v našem [průvodci testováním / sandboxem](/in-store/getting-started/testing).

## Autentizace [#authentication]

Požadavky na Platform API používají váš Server Secret Token, na stránce API Keys označený jako **Secret key**. Předávejte ho beze změny v hlavičce `Authorization` svých HTTP požadavků.

```http
Authorization: REPLACE_ME
```

Abyste svou platformu vůči API autentizovali, musíte na [stránce API Keys](https://platform.tapaya.com/api-keys/) vygenerovat **Secret key**, zde označovaný jako Server Secret Token, a nahradit jím *REPLACE\_ME* výše.

<Callout title="Bezpečnostní upozornění" type="warn">
  Váš Server Secret Token má vysoká oprávnění. **Nikdy** ho nezveřejňujte v kódu na straně klienta (mobilní aplikace, webové
  prohlížeče). Smí se používat pouze z vašich zabezpečených backendových serverů.
</Callout>

Pokud je token kompromitován, zneplatněte ho na [stránce API Keys](https://platform.tapaya.com/api-keys/); zneplatnění
platí okamžitě a nelze ho vrátit zpět. Náhradní token vygenerujte před zneplatněním nebo po něm, podle potřeby;
akce „rotace“ tokenu na místě neexistuje, takže jakmile nový token vytvoříte, aktualizujte s ním konfiguraci svého backendu.

<Callout title="Bez omezení rozsahu klíčů" type="info">
  Každý Server Secret Token má stejná oprávnění v rámci celé organizace; tokeny zatím nelze omezit na
  konkrétní endpointy nebo obchodníky. Každý token považujte za ekvivalent plného přístupu k API pro vaši organizaci.
</Callout>

Server je dostupný pouze přes protokol HTTPS, přičemž na úrovni infrastruktury je vynucen TLS 1.2 nebo novější. Platí omezení počtu požadavků (100 požadavků za minutu na IP adresu); požadavky, které server přetěžují, vrátí chybu `429 Too Many Requests`.