Preskočiť na obsah

Prehľad API

Verejné API Kudosky vám umožní ťahať ľudí, kudos, odmeny a anonymné dáta o nálade do BI nástrojov, tabuliek a vlastných systémov a importovať katalóg odmien z iného systému.

https://kmlrvcofvtzdlbomxrbp.supabase.co/functions/v1/external-api

Admin vytvára kľúče v Integrácie → Verejné API → Vytvoriť kľúč:

  1. Pomenujte kľúč podľa toho, čo ho používa, napríklad Power BI dashboard.
  2. Zaškrtnite len oprávnenia, ktoré potrebuje.
  3. Skopírujte kľúč. Začína sk_live_ a zobrazí sa raz. Uložte ho do správcu hesiel alebo trezoru tajomstiev.

Zrušenie kľúča okamžite zastaví všetky integrácie, ktoré ho používajú.

Kľúč pošlite v jednej z hlavičiek:

Authorization: Bearer sk_live_…
X-API-Key: sk_live_…

Požiadavka vždy vidí len firmu, ktorej kľúč patrí.

Oprávnenie Povoľuje
read:members GET /members: mená, e-maily, roly a tímy
read:activity GET /activity: kudos s odosielateľom, príjemcom a kategóriou
read:rewards GET /rewards: katalóg odmien
read:analytics GET /day-ratings a GET /pulse-responses, bez identity
write:rewards POST /rewards: import katalógu

Nové kľúče majú predvolene read:members a read:activity.

Terminal window
curl "https://kmlrvcofvtzdlbomxrbp.supabase.co/functions/v1/external-api/activity?limit=10" \
-H "Authorization: Bearer sk_live_…"

Volanie základnej URL bez cesty overí kľúč: vráti verziu API, oprávnenia kľúča a endpointy.

Parameter Platí pre Význam
limit každý zoznam 1–1000, predvolene 100
format každý zoznam json (predvolene) alebo csv
since, until kudos, hodnotenia dňa, pulse časový rozsah v ISO 8601
team_id členovia, hodnotenia dňa jeden tím
role členovia jedna rola
category_id, sender_id, receiver_id kudos jedna kategória alebo osoba
include_archived=true odmeny aj archivované odmeny

Zoznamy sú od najnovších. Stránkovanie nie je: viac ako 1000 riadkov získate zúžením okna cez since a until.

Stav Kedy
400 Neplatné telo pri importe odmien. Nič sa nezapíše.
401 Chýbajúci, chybný alebo zrušený kľúč.
403 Kľúč nemá oprávnenie pre tento endpoint.
500 Chyba na našej strane. Detaily logujeme, nevraciame.

Chyby majú tvar { "error": "…" }. Všetky endpointy nájdete v referencii.