Rováš API

Rováš poskytuje REST API, cez ktoré partneri, doplnky a aplikácie môžu zakladať účty, podávať pracovné výkazy, čítať Merity a napojiť sa na produkty NeoFund (napríklad Civic).

Cesty služieb majú predponu /rovas. OAuth protokol používa /oauth2.

Posielajte Accept: application/json a pri tele POST/PUT aj Content-Type: application/json.

Ak plánujete integráciu, kontaktujte nás — radi zabezpečíme partnerský prístup a prejdeme váš prípad použitia.

Ktoré API použiť?

Na jednom volaní tieto modely nemiešajte. Klasické endpointy očakávajú API kľúče; Civic/OAuth zdroje majú API-key auth vypnutú a očakávajú Bearer (alebo sú verejné).

Klasické API — ako ho používať

Prihlasovacie údaje

1. Prihláste sa do Rováša a otvorte Môj účet → Rováš API.
2. Vygenerujte údaje pre endpoint rovas_endpoint.
3. Pri každom autentifikovanom volaní pošlite:

API-KEY: <váš api kľúč>
TOKEN: <váš token>

Každý pár kľúčov patrí jednému používateľovi Rováša. Volania bežia v jeho mene.

Partnerská registrácia (vytvorenie alebo prepojenie koncového používateľa)

Partneri (napr. neziskovky), ktorí zakladajú účty darcom alebo členom, potrebujú technický účet s rolou api client (pridelí NeoFund/Rováš). API kľúč tohto účtu slúži len na zakladanie / prepojenie účtov.

Odporúčaný endpoint

POST /rovas/rovas_partner_user

Starší ekvivalent: POST /rovas/rules/rules_create_user (rovnaké telo a odpoveď).

Telo požiadavky (povinné polia)

Voliteľné: hybridauth_provider (ak prázdne, predvolené Nabezky), partner_client_id.

Zoznam povolených poskytovateľov: GET /rovas/rovas_hybridauth_providers.json (zvyčajne verejné).

Úspešná odpoveď

{
  "rovas_uid": 123,
  "api_key": "…",
  "token": "…"
}

Uložte vrátené api_key / token a používajte ich ako API-KEY / TOKEN pri ďalších volaniach v mene tohto koncového používateľa.

Príklad

curl -sS -X POST "https://rovas.app/rovas/rovas_partner_user" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "API-KEY: $PARTNER_API_KEY" \
  -H "TOKEN: $PARTNER_TOKEN" \
  -d '{
    "user_name": "Jana Partnerská",
    "user_id": 12345,
    "user_email": "jana@example.com",
    "user_country": "SK",
    "user_language": "sk",
    "server_url": "https://partner.example/",
    "hybridauth_provider": "Nabezky"
  }'

Typické chyby: 400 validácia, 401 zlé údaje, 403 chýba oprávnenie api client.

Referencia klasických endpointov

Schémy požiadaviek/odpovedí sú v OpenAPI súbore (na vyžiadanie). Prehľad:

Účty a zostatky

*Ak je na zdroji zapnuté „Disable API keys authentication“.

Projekty a pracovné výkazy

Podiely, nákupy, kurzy

Views

OAuth 2 / Bearer — ako ho používať

OAuth používa aplikácia Civic a ďalší klienti, ktorých registrujeme. Nové produkty potrebujú vlastný OAuth klient — z tretích strán nepoužívajte Civic client_id.

Protokolové endpointy

Civic klient (referencia)

Dodatočné parametre authorize: lang=sk|en, intent=login|register.

Volanie API s Bearer

curl -sS "https://rovas.app/rovas/me" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Príklad odpovede GET /rovas/me:

{
  "uid": 42,
  "username": "sano",
  "display_name": "Alexander Žaťko",
  "total_me": 1248.35,
  "total_chr": 320.0,
  "created": "2019-03-12T14:22:01+00:00",
  "language": "sk",
  "receipt_history_retention": null
}

Referencia OAuth / Civic endpointov

Auth: Bearer = povinný access token; Verejné = bez tokenu; Voliteľný Bearer = verejné, s extra poliami po prihlásení.

Domov a profil

Používatelia

Daňové (DPH) nároky

Projekty a organizácie vo verejnom prospechu

*Anonymný prístup pre schválené projekty vo verejnom prospechu; inak platia pravidlá prístupu.

Dobrovoľnícke pracovné výkazy

Overovanie a upozornenia

Merit index

Podpora

Otázky, OpenAPI schémy alebo nový OAuth klient: kontaktujte NeoFund.