Explore

QUiCK publikus API

Executive Summary

A QUiCK API egy REST/JSON alapú interfész, amellyel jogosult külső rendszerek programozottan férhetnek hozzá a QUiCK-ben tárolt pénzügyi és dokumentumadatokhoz. Tipikus használat: kontrolling/BI, könyvelőprogram-integráció, automatizált riportok és szinkronok. A technikai (interaktív) dokumentáció az API-portálon érhető el.

Kiknek szól?

Pénzügyi vezetők / BI csapat – adatexport Power BI/BigQuery felé, gördülő kimutatások.

Szoftverfejlesztők / integrátorok – könyvelőprogramok és HR/Payroll rendszerek integrációja, saját vállalati eszközök adatellátása.

⁠

Fő képességek (áttekintés)

Számlák (bevétel/költség) és számlaképek (OCR-rel bővített metaadatok).

Kifizetések, adók és bérek listázása.

Partnerek, pénztárcák, egyenlegek, adókódok elérése.

RESTful végpontok, JSON válaszok, szabványos HTTP státuszkódok.

Megjegyzés: A jóváhagyási folyamat (pl. Haladó jóváhagyás) elsődlegesen felületi funkció; az API célja az adat-hozzáférés, nem workflow-k „megkerülése”.

⁠

Gyors kezdés (Quick Start)

1) Hozz létre API tokent

A QUiCK-ben (admin jogosultsággal) hozz létre céghez kötött API tokent, és mentsd biztonságos helyre (vault). A részletes lépések a súgócikkben találhatók.

2) Nyisd meg a technikai dokumentációt

Az interaktív (böngészőből kipróbálható) API-dokszi az API-portálon érhető el; ott megtalálod a végpontok, paraméterek és válaszok pontos leírását.

3) Első hívás (példa)

curl -H "Authorization: Token <API_TOKEN>" \

-H "Accept: application/json" \

"https://api.riport.app/<endpoint>"

⁠

Hitelesítés és biztonság

Token-alapú hozzáférés

Bearer token szükséges minden védett végponthoz (HTTP Authorization fejléc).

A token céges scope-ú: csak az adott cég adatai érhetők el vele.

Legjobb gyakorlatok (összefoglaló)

Ne ágyazd be a tokent kliensoldali kódba; használj szerver oldali proxy-t.

Naplózd a hívásokat (trace ID, endpoint, időbélyeg, státusz), és állíts be riasztásokat 4xx/5xx mintázatokra.

Hozz létre kvótát / rate limit-figyelést a saját rendszeredben is.

⁠

API alapok

Bázis URL: https://api.riport.app/

Formátum: application/json.

REST szemlélet: erőforrás-orientált végpontok, GET listázás/letöltés, szűrés és lapozás támogatott.

⁠

Erőforrás-katalógus (tematikus bontás)

A pontos útvonalak és mezők az interaktív doksiban szerepelnek; az alábbi lista felhasználói szemléletű fogódzó.

Számlák (bevétel/költség)

Mit érsz el? Számlafej + tételek + extra metaadat; számlakép.

Mire jó? Könyvelőprogram-szinkron, költséghely-elemzés, dokumentumtár építése.

Számlaképek és egyéb dokumentumok

Mit érsz el? Számlaképek, csatolmányok, metaadatok (iktatási adatok).

Mire jó? Digitális dokumentumkezelés és audit-nyomvonal.

Kifizetések

Mit érsz el? Kimenő/belső kifizetések listázása összeggel, dátummal, státusszal.

Mire jó? Likviditás-kimutatás, banki egyeztetés.

Adók és bérek

Mit érsz el? Időszakos adók és bérkifizetések listázása.

Mire jó? Cash-flow tervezés, automatikus határidő-követés kiegészítése.

Partnerek

Mit érsz el? Partner-törzs adatok (név, azonosítók, bankszámla stb.).

Mire jó? Törzsadat-konzisztencia fenntartása kétirányú integrációban.

Pénztárcák és egyenlegek

Mit érsz el? Pénztárca-lista, bankszámla típusú pénztárcák, egyenlegek.

Mire jó? Központosított számlakezelés, BI-egyenlegriport.

Megjegyzés: Az interaktív doksi minden erőforráshoz példahívásokat és válasz-sémát ad.

⁠

Szűrés, rendezés, lapozás

Időablak: from–to (UTC dátum/idő) jellegű paraméterek végpontonként.

Státusz szűrés: „kifizetett / kifizetetlen / jóváhagyott / hiányos” jellegű állapotmezők ott, ahol relevánsak (az elérhető értékek végpontonként eltérhetnek).

Lapozás: page/page_size vagy limit/offset jellegű paraméterek – ellenőrizd az interaktív doksiban a konkrét formát.

⁠

Hibakezelés (minta-séma)

200/201 – sikeres válasz.

400 – hibás kérés (paraméter vagy formátum).

401/403 – hitelesítés/hozzáférés hiba (token hiányzik/érvénytelen vagy jogosultság hiányzik).

404 – nem található erőforrás.

409 – ütközés/állapotkonfliktus.

429 – túl sok kérés (rate limit).

5xx – szerveroldali hiba. A részletes hibaobjektum és mezők végpontonként a doksiban.

⁠

Mintakódok

cURL

# Számlák listázása időszakra

curl -H "Authorization: Token $API_TOKEN" \

-H "Accept: application/json" \

"https://api.riport.app/invoices?from=2025-01-01&to=2025-01-31&status=unpaid"

Python (requests)

import requests, os

API_TOKEN = os.getenv("API_TOKEN")

r = requests.get(

"https://api.riport.app/invoices",

params={"from": "2025-01-01", "to": "2025-01-31", "status": "unpaid"},

headers={"Authorization": f"Token {API_TOKEN}", "Accept": "application/json"},

timeout=30,

)

r.raise_for_status()

data = r.json()

print(len(data["results"]), "számla")

Node.js (fetch)

const res = await fetch(

"https://api.riport.app/payments?from=2025-01-01&to=2025-01-31",

{ headers: { Authorization: `Token ${process.env.API_TOKEN}` } }

);

if (!res.ok) throw new Error(`${res.status} ${res.statusText}`);

const json = await res.json();

console.log(json.results.length, "kifizetés");

Tipp: Képfájlok letöltésénél a válasz típusa lehet bináris vagy URL-referencia; nézd meg a végpont leírását a doksiban.

⁠

Gyakori „receptek”

Havi kintlévőség (open receivables)

Számlák status=unpaid + partner szerinti csoportosítás (BI oldalon).

Számlaképek archiválása

Számlák listázása → számlakép letöltése → S3/SharePoint feltöltés és verziózás.

Kifizetések egyeztetése

Kifizetések from/to szerinti lekérés → bankforgalmi kimutatással összevetés (összeg/dátum).

Adók és bérek cash-flow előrejelzéshez

Időszakos adó/bér listák integrálása a pénzforgalmi modellbe.

⁠

Biztonság és megfelelés

Token-kezelés: titkos kulcstár (vault), rotáció, legkisebb jogosultság elve.

Naplózás: minden hívásnál request-ID és státusz rögzítése; 4xx/5xx riasztások.

Adatvédelem: a hívások személyes és üzleti adatokat érinthetnek – igazodj a vállalati DLP és adatvédelmi szabályokhoz.

⁠

Intercom FIN AI – kész rövid válaszok

Mi az a QUiCK API? REST/JSON felület a QUiCK-adatokhoz (számlák + képek, kifizetések, adók, bérek, partnerek, pénztárcák, egyenlegek).

Hol találom a dokumentációt? Az interaktív doksi az API-portálon érhető el (végpontok, paraméterek, minták).

Hogyan kezdem el? QUiCK → Admin → API token létrehozása → próbáld ki a doksiból vagy Postmannel.

Tudok számlaképet is? Igen, a számlák mellett a számlaképek és egyéb dokumentumok is elérhetők végponttól függően.

Mit tegyek, ha 401/403-at kapok? Ellenőrizd a Bearer tokent, a céges scope-ot és a jogosultságokat; lásd a doksi hibakód-szekcióját.

⁠

Beépítési javaslat a szolgáltatásdoksiba (nemzetközi best practice)

Összefoglaló – mit ad az API, kinek.

Quick Start – token, első hívás, kipróbálás.

Hitelesítés és biztonság – tokenkezelés, rotáció.

Erőforrás-katalógus – felhasználói szemléletű csoportosítás, linkek az interaktív doksi megfelelő pontjaira.

Szűrés, lapozás, minták – gyakori paraméterek és receptek.

Hibakezelés – kódtáblázat + gyakori okok.

Mintakód – cURL, Python, Node.js.

Changelog és támogatás – változáskezelés, kapcsolat.

Want to print your doc?
This is not the way.

Try clicking the ··· in the right corner or using a keyboard shortcut (

CtrlP

) instead.