API kľúče

Vytvorte si kľúče na prepojenie vlastných nástrojov s VEXiON cards API a presne určte, čo každý z nich smie robiť.

Záložka Pre vývojárov v Nastaveniach slúži na prepojenie vášho vlastného softvéru s VEXiON cards. Má až tri časti: API kľúče (táto stránka), Webhooky a AI asistenti. Časť AI asistenti sa zobrazí, iba ak je pre váš účet dostupná. Záložka Pre vývojárov je dostupná pre administrátorov.

API kľúče a webhooky sú dostupné vo všetkých plánoch okrem plánu VEXiON cards ONE. V pláne ONE záložka Pre vývojárov zostáva, no namiesto nástrojov vám ponúkne prechod na vyšší plán.

API kľúč je tajné heslo pre program. Kým vy sa do nástenky prihlasujete e‑mailom, vaše skripty, váš web alebo systém partnera sa do VEXiON cards API prihlasujú kľúčom. Kľúč dokáže všetko, čo dokáže API, a práve preto má každý kľúč len tie oprávnenia, ktoré mu udelíte.

Kľúče vytvorené tu začínajú na vxn_sk_. Sú to produkčné kľúče a pracujú s vašimi živými vernostnými dátami hneď. Samostatný sandbox zriaďujeme na požiadanie: kontaktujte nás a vytvoríme vám sandbox organizáciu s vlastným kľúčom vxn_test_sk_, ktorý sa používa na adrese https://migration.api.vexioncards.one. Adresu sandboxu vám pošleme spolu s testovacím kľúčom. S každým kľúčom z tejto záložky zaobchádzajte ako s produkčným.

Nastavenia → Pre vývojárov → API kľúče

​

Vytvorenie kľúča

1. Otvorte záložku Pre vývojárov

   Prejdite do Nastavenia → Pre vývojárov a zostaňte na záložke API kľúče.

2. Kliknite na Vytvoriť kľúč

   Zadajte Označenie, názov, ktorý vidíte len vy, aby ste kľúče od seba odlíšili (napríklad Produkčný server, Zapier alebo Export pre účtovníka). Pre každý systém použite samostatný kľúč, nikdy nezdieľajte jeden kľúč medzi viacerými. Kľúč potrebuje označenie a aspoň jedno oprávnenie.

3. Vyberte jeho oprávnenia

   Zaškrtnite len tie oprávnenia, ktoré kľúč potrebuje, a nič navyše (pozri Oprávnenia nižšie).

4. Súhlaste s podmienkami pre API

   Zaškrtnite políčko, ktorým potvrdzujete, že vytvorením kľúča súhlasíte s čl. 7 a 8 VOP (Platformy tretích strán a Verejné API) a s Prílohou 1 VOP (DPA) pre údaje spracúvané cez API. Odkaz vedľa neho otvorí zverejnené znenie. Tlačidlo Vytvoriť kľúč zostáva neaktívne, kým políčko nezaškrtnete.

5. Skopírujte kľúč, jedenkrát

   Kliknite na Vytvoriť kľúč. Celý kľúč sa zobrazí iba raz. Hneď si ho skopírujte a vložte do nastavení svojho systému.

Kľúč sa zobrazí raz a už ho nikdy neuvidíte. Z bezpečnostných dôvodov uchovávame len zašifrovanú podobu, takže ho nedokážeme obnoviť ani znova zobraziť. Ak ho stratíte, kľúč odvolajte a vytvorte nový.

​

Oprávnenia

Oprávnenia (scopes) sú jednotlivé povolenia, ktoré kľúč nesie. Sú dvoch druhov:

• Prístup na čítanie (...:read), kľúč smie dané dáta zobraziť.
• Prístup na zápis (...:write / ...:send), kľúč smie dané dáta meniť alebo vytvárať.

Zapnite Všetky oprávnenia a udelíte naraz všetko (hlavný kľúč), alebo zaškrtnite len tie políčka, ktoré potrebujete. Zlaté pravidlo je čo najmenej oprávnení: kľúč, ktorý len exportuje zákazníkov, má mať customers:read a nič iné, aby unesený kľúč narobil čo najmenej škody.

Výber oprávnení pri vytváraní kľúča

Oprávnenie	Čo umožňuje
customers:read	Zobrazenie profilov a zostatkov zákazníkov
customers:write	Vytváranie, úprava alebo mazanie zákazníkov
cards:read	Zobrazenie detailov a zostatkov kariet
cards:write	Vytváranie, úprava alebo mazanie kariet
transactions:read	Zobrazenie histórie transakcií a odmien
transactions:write	Zaznamenávanie nových transakcií
products:read	Zobrazenie produktov a ich cien
products:write	Vytváranie a úprava produktov (bez mazania, produkt vyradíte nastavením is_active=false)
custom_fields:read	Zobrazenie definícií vlastných polí
custom_fields:write	Vytváranie, úprava alebo mazanie vlastných polí
locations:read	Zobrazenie predajných miest
locations:write	Úprava predajných miest (bez vytvárania a mazania)
team_members:read	Zobrazenie údajov o členoch tímu
team_members:write	Pozývanie a úprava členov tímu (bez odstraňovania)
notifications:read	Zobrazenie odoslaných notifikácií a stavu ich doručenia
notifications:send	Odosielanie push notifikácií zákazníkom
webhooks:read	Zobrazenie webhookových koncových bodov a pokusov o doručenie
webhooks:manage	Vytváranie, úprava a správa webhookových koncových bodov
organization:read	Zobrazenie údajov o organizácii, plánu a faktúr

Kľúč nikdy nedokáže viac, než mu dovoľujú jeho oprávnenia. Ak požiadavka potrebuje povolenie, ktoré kľúč nemá, API ju odmietne, takže udeliť menej je vždy bezpečné.

​

Použitie kľúča

Kľúč posielajte pri každej požiadavke v hlavičke Authorization ako Bearer token:

curl https://api.vexioncards.one/v1/customers \
  -H "Authorization: Bearer VAS_API_KLUC"

To je celé overenie. Ďalej všetko, čo sa dá robiť, nájdete v API referencii, začnite Rýchlym štartom a potom si pozrite Stránkovanie, Limity požiadaviek, Idempotenciu a Chyby.

​

Správa kľúčov

Každý kľúč v tabuľke zobrazuje svoje označenie, zamaskovaný náhľad kľúča, jeho oprávnenia, stav a kedy bol vytvorený.

Stav	Význam
Aktívny	Funguje normálne.
Pozastavený	Dočasne vypnutý. Každá požiadavka, ktorá ho používa, je odmietnutá.
Zrušený	Natrvalo vypnutý. Každá požiadavka, ktorá ho používa, je odteraz odmietnutá.

​

Odvolanie kľúča

Otvorte ponuku ⋯ pri kľúči a zvoľte Odvolať, keď sa kľúč už nepoužíva, mohol uniknúť, alebo patril systému, ktorý ste vyradili.

Odvolanie sa nedá vrátiť späť a každá požiadavka s daným kľúčom prestane fungovať približne do 60 sekúnd. Ak nejaký systém prístup ešte potrebuje, najprv mu vytvorte nový kľúč a až potom starý odvolajte.

​

Ďalšie kroky

Nastavte si webhooky

Dostanete podpísanú správu vo chvíli, keď sa niečo stane, namiesto neustáleho zisťovania zmien.

API referencia

Úplná dokumentácia každého endpointu, poľa a odpovede.