📦 Általános leírás¶

Ez a dokumentáció áttekintést nyújt a DimSQL API által biztosított végpontokról és azok használatáról.

⚠️ Előfeltételek¶

A DimSQL API használatához kötelező előfeltétel a Dimenzió Kft. VPS szolgáltatásának megrendelése. Az API csak akkor működik, ha:

• ✅ Megrendelte a Dimenzió Kft. VPS szolgáltatását
• ✅ Rendelkezik érvényes DimSQL előfizetéssel
• ✅ Rendelkezik érvényes API tokennel
• ✅ Az adatbázisai a mi szervereinken vannak tárolva

⚠️ Fontos: Az API nem működik helyi adatbázisokkal vagy külső szerverekkel. Az adatbázisoknak kötelezően a Dimenzió Kft. szerverein kell lenniük, hogy a web szerverünk hozzáférhessen.

VPS Szolgáltatás megrendelése¶

A VPS szolgáltatás megrendeléséhez vegye fel a kapcsolatot velünk:

• 📧 E-mail: iroda@dimenzio-kft.hu
• 🌐 Weboldal: dimenzio-kft.hu

🚀 Alapinformációk¶

• Alap URL: https://query.dimsql.hu
• API Verzió: v1
• Protokoll: HTTPS
• Formátum: JSON
• Kódolás: UTF-8
• Időzóna: Europe/Budapest

🔐 Hitelesítés¶

Minden API híváshoz szükséges egy érvényes API token megadása az X-Token HTTP fejlécben.

Kötelező fejléc

X-Token: [your-api-token-here]
Content-Type: application/json

API Token beszerzése

Az API token beszerzéséhez:

1. Rendelje meg a VPS szolgáltatásunkat

2. Vegye fel velünk a kapcsolatot az iroda@dimenzio-kft.hu címen

3. Amennyiben minden adatot megadott, megküldjük az egyedi API tokent

🌐 Elérhető végpontok¶

📊 Főkönyvi lekérdezések¶

/v1/general_ledger/account Főkönyvi számlakarton adatok lekérdezése.

Dokumentáció: 📖 Részletes leírás

Rövid leírás: - Főkönyvi tételek lekérdezése különböző szűrőkkel - Dátum, számla és partner alapú szűrés - Teljes számlakarton vagy részletes forgalmi adatok

Példa URL:

GET /v1/general_ledger/account?company=ABC&year=2025&account_number_from=311&account_number_to=319

📦 Készlet lekérdezések¶

/v1/stock/card_list Készlet karton lista adatok lekérdezése.

Dokumentáció: 📖 Részletes leírás

Rövid leírás: - Készletmozgások lekérdezése - Cikkszám, cikkcsoport és raktár alapú szűrés - Kumulált készletállomány információk

Példa URL:

GET /v1/stock/card_list?company=ABC&year=2025&date_from=2025-01-01&show_zero_quantity=N

🔍 Státusz ellenőrzés¶

/v1/status API szerver állapotának ellenőrzése.

Metódus: GET Paraméterek: Nincsenek Hitelesítés: Nem szükséges

Példa válasz:

{
  "status": "ok"
}

🔧 Paraméterek¶

Közös paraméterek Az alábbi paraméterek minden adatlekérdező végpontnál kötelezőek:

ℹ️ A db_info paramétert csak akkor szükséges megadni, ha több adatbázis van egy cégen és éven belül, pl. készlet és főkönyv külön.

Opcionális közös paraméterek

📄 Válasz formátum¶

Sikeres válasz struktúra

{
  "success": true,
  "status": 200,
  "error": null,
  "message": "OK",
  "data": [
    // ... adatok tömbje
  ]
}

Hibás válasz struktúra

{
  "success": false,
  "status": 400,
  "error": "Hiba üzenet",
  "message": "Bad Request",
  "data": null
}

❌ Hibakezelés¶

HTTP Státusz kódok

Gyakori hibák

1. Hiányzó kötelező paraméterek

   {
     "success": false,
     "status": 400,
     "error": "Missing required parameters: company and year"
   }
   

2. Érvénytelen API token

   {
     "success": false,
     "status": 401,
     "error": "Invalid token"
   }
   

3. Adatbázis kapcsolat hiba

   {
     "success": false,
     "status": 500,
     "error": "Database connection error"
   }
   

💡 Tippek¶

1. Teljesítmény optimalizáció

• Használja a fields paramétert csak a szükséges mezők lekérdezéséhez
• Alkalmazzon időintervallum szűrést nagy adatmennyiségeknél
• Használjon specifikus szűrőket (számla, cikk tartományok)

2. Hibakezelés

• Mindig ellenőrizze a success mezőt a válaszban
• Implementáljon retry logikát hálózati hibák esetén
• Logolja az API hívásokat és válaszokat debugging céljából

3. Biztonság

• Soha ne tárolja az API tokent plain text formában
• Használjon HTTPS-t minden API híváshoz
• Korlátozza az API token hozzáférést csak a szükséges felhasználókra

4. Sebesség korlát

• Ne küldjön túl sok egyidejű kérést
• Implementáljon késleltetést a kérések között
• Figyelje a szerver válaszidőt

🔍 Használati példák¶

Power Query (Microsoft Excel/Power BI) Minden végponthoz rendelkezésre állnak részletes Power Query példák a végpont-specifikus dokumentációkban.

cURL parancssor

curl -X GET \
  "https://query.dimsql.hu/v1/status" \
  -H "X-Token: your-api-token-here" \
  -H "Content-Type: application/json"

Python

import requests

headers = {
    'X-Token': 'your-api-token-here',
    'Content-Type': 'application/json'
}

params = {
    'company': 'your-company',
    'year': 2025
}

response = requests.get(
    'https://query.dimsql.hu/v1/general_ledger/account',
    headers=headers,
    params=params
)

data = response.json()

📊 Adatkezelés és GDPR¶

Adatvédelem

• Az API tokennel csak a saját adatbázisaihoz férhet hozzá
• Minden adat titkosított kapcsolaton keresztül kerül továbbításra
• Az API tokenek egyedi azonosítók, nem tartalmaznak személyes adatokat

Adatmegőrzés

• Az API nem tárol lekérdezési eredményeket
• A logok csak hibakeresési célokat szolgálnak
• Személyes adatok nem kerülnek naplózásra

📞 Támogatás¶

Technikai támogatás

• 📧 E-mail: iroda@dimenzio-kft.hu
• 🕐 Nyitvatartás: Hétfő-Péntek 9:00-15:00
• ⚡ Válaszidő: 2 munkanapon belül

Dokumentáció frissítések

• 📅 Rendszeres frissítés: Havonta
• 🔔 Változások értesítése: E-mailben

Hibabejelentés

1. Gyűjtse össze a hibás API hívás részleteit
2. Mentse el a hibaüzenetet és státusz kódot
3. Küldje el az iroda@dimenzio-kft.hu címre
4. Várja meg a támogatási csapat válaszát

📋 Verziótörténet¶

v1.0.0 (2025-07-25)

• ✨ Kezdeti API verzió
• 📊 Főkönyvi karton lekérdezés
• 📦 Készlet karton lekérdezés
• 🔐 Token alapú hitelesítés
• 📚 Teljes dokumentáció

💡 Tipp: Kezdje a /v1/status végpont tesztelésével, hogy ellenőrizze az API kapcsolatot, majd próbálja ki a részletes végpontokat a megfelelő dokumentációk alapján.

📅 Utolsó frissítés: 2025-07-25 | 📝 Verzió: 1.0.0 | 👥 Fejlesztette: Dimenzió Kft.