Regisztráció Belépés

Ügyfél kapcsolat API

CRM bejegyzések és ügyfélkapcsolatok kezelése — lekérés, létrehozás, módosítás, lezárás és letöltés

Végpontok

Authentikáció

Minden API kéréshez szükséges az X-API-KEY header küldése.

X-API-KEY: {az_api_kulcsod}

Maradt még kérdésed?

Írj ticketet nekünk, vagy nézz körbe a keresőnkben.

Ha tetszett, oszd meg másokkal

Alap URL

https://{tenant}.logzi.com/api/crm/

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0.

GET /api/crm/get

Egyetlen CRM bejegyzés lekérése azonosító alapján, teljes részletekkel.

Query paraméterek

Paraméter Típus Kötelező Leírás
id int A CRM bejegyzés egyedi azonosítója

Példa kérés

GET /api/crm/get?id=15
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 15,
    "identify": "CRM-2024-0015",
    "date_create": "2024-05-01 10:00:00",
    "date_perform": "2024-05-10",
    "status_id": 1,
    "subject": "Ügyféltárgyalás",
    "partner_company_name": "Minta Kft.",
    "company_user_name": "Kovács János",
    "crm_source_name": "Telefon",
    "comment_top": "Előzetes egyeztetés.",
    "comment_bottom": "Belső megjegyzés."
  }
}
GET /api/crm/list

CRM bejegyzések listájának lapozható lekérése szűrési lehetőségekkel.

Query paraméterek

Paraméter Típus Kötelező Leírás
list_offset int Lapozás eltolása (alapértelmezett: 0)
list_condition[identify] string Szűrés azonosítóra (LIKE)
list_condition[company_name] string Szűrés partner nevére (LIKE)
list_condition[status_id] int Szűrés státuszra (1=nyitott, 2=lezárt)
list_condition[crm_source_id] int Szűrés forrás azonosítóra
list_condition[company_user_id] int Szűrés felelős munkatárs ID-re
list_condition[date_create_from] date Létrehozás dátuma — tól (YYYY-MM-DD)
list_condition[date_create_to] date Létrehozás dátuma — ig (YYYY-MM-DD)

Példa kérés

GET /api/crm/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 15,
      "identify": "CRM-2024-0015",
      "date_create": "2024-05-01",
      "status_name": "Nyitott",
      "subject": "Ügyféltárgyalás",
      "partner_company_name": "Minta Kft."
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 42
  }
}
POST /api/crm/save

CRM bejegyzés létrehozása vagy módosítása. Új bejegyzéshez data[id] = 0, módosításhoz a meglévő ID-t add meg.

POST mezők — data objektum

Mező Típus Kötelező Leírás
id int 0 = új CRM bejegyzés, >0 = módosítás
company_id int Cég azonosítója
company_user_id int Felelős munkatárs ID
partner_id int Partner/ügyfél azonosítója
crm_source_id int Forrás azonosítója
subject string Tárgy
date_perform datetime Teljesítés dátuma (YYYY-MM-DD HH:MM:SS)
comment_top string Ügyfelnek látható megjegyzés
comment_bottom string Belső megjegyzés
status_id int Státusz azonosítója

POST mezők — params objektum (opcionális)

Mező Típus Kötelező Leírás
close int 1 = mentés után automatikus lezárás
download int 1 = mentés után PDF generálás

Példa kérés

POST /api/crm/save
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "partner_id": 12,
    "crm_source_id": 2,
    "subject": "Termékbemutató egyeztetés",
    "date_perform": "2024-06-20 14:00:00",
    "comment_top": "Ügyfél érdeklődik az új termékcsalád iránt.",
    "status_id": 1
  },
  "params": {
    "close": 0,
    "download": 0
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 16,
    "identify": "CRM-2024-0016"
  }
}
POST /api/crm/delete

CRM bejegyzés törlése. Csak nyitott státuszú bejegyzés törölhető.

POST mezők — data objektum

Mező Típus Kötelező Leírás
receipt_id int A törlendő CRM bejegyzés azonosítója

Példa kérés

POST /api/crm/delete
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "receipt_id": 15
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
POST /api/crm/close

Nyitott CRM bejegyzés lezárása. Csak status_id = 1 (nyitott) bejegyzés zárható le.

POST mezők — data objektum

Mező Típus Kötelező Leírás
receipt_id int A lezárandó CRM bejegyzés azonosítója

Példa kérés

POST /api/crm/close
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "receipt_id": 15
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
GET /api/crm/download

CRM bejegyzés dokumentumának letöltése/generálása különböző formátumokban (PDF, base64 string, stream).

Query paraméterek

Paraméter Típus Kötelező Leírás
receipt_id int A CRM bejegyzés azonosítója
file_type string Kimeneti formátum: pdf, pdf-string, stream
language string Sablon nyelvi mappa neve (pl. hungarian)
template_id int Egyedi nyomtatási sablon ID

Példa kérés

GET /api/crm/download?receipt_id=15&file_type=pdf
X-API-KEY: {az_api_kulcsod}

Példa válasz (file_type=pdf)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "name": "CRM-2024-0015.pdf",
    "content": "JVBERi0xLjQK...",
    "receipt": { ... }
  }
}

Vedd fel a kapcsolatot velünk

Érdeklődsz a szoftverünkkel kapcsolatban, írj bátran!

Érdeklődés küldése

Segítségre van szükséged?

Ha nem találod a választ és szükséged van segítségre

Nézz körbe a help centerben

Regisztrációdat hozd létre most,
fizess később!

Próbáld ki 3 napig ingyen, kockázatok és kötöttségek nélkül!
Regisztráció készítése
Regisztráció