Registrácia Prihlásenie

CRM API

Správa záznamov CRM a vzťahov so zákazníkmi — načítanie, vytvorenie, úprava, uzavretie a stiahnutie

Koncové body

Autentifikácia

Ku každej API požiadavke je potrebné odoslať hlavičku X-API-KEY.

X-API-KEY: {vas_api_kluc}

Máte ešte otázky?

Napíšte nám tiket, alebo si pozrite naše centrum pomoci.

Ak sa vám páčilo, podeľte sa s ostatnými

Základná URL

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

Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0.

GET /api/crm/get

Načítanie jedného záznamu CRM na základe identifikátora, s kompletnými podrobnosťami.

Query parametre

Parameter Typ Povinné Popis
id int Jedinečný identifikátor záznamu CRM

Príklad požiadavky

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

Príklad odpovede

{
  "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

Stránkovateľné načítanie zoznamu záznamov CRM s možnosťami filtrovania.

Query parametre

Parameter Typ Povinné Popis
list_offset int Posun stránkovania (predvolené: 0)
list_condition[identify] string Filter podľa identifikátora (LIKE)
list_condition[company_name] string Filter podľa názvu partnera (LIKE)
list_condition[status_id] int Filter podľa stavu (1=otvorený, 2=uzavretý)
list_condition[crm_source_id] int Filter podľa identifikátora zdroja
list_condition[company_user_id] int Filter podľa ID zodpovedného pracovníka
list_condition[date_create_from] date Dátum vytvorenia — od (YYYY-MM-DD)
list_condition[date_create_to] date Dátum vytvorenia — do (YYYY-MM-DD)

Príklad požiadavky

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

Príklad odpovede

{
  "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

Vytvorenie alebo úprava záznamu CRM. Pre nový záznam zadajte data[id] = 0, pre úpravu zadajte existujúce ID.

POST polia — objekt data

Pole Typ Povinné Popis
id int 0 = nový záznam CRM, >0 = úprava
company_id int Identifikátor firmy
company_user_id int ID zodpovedného pracovníka
partner_id int Identifikátor partnera/zákazníka
crm_source_id int Identifikátor zdroja
subject string Predmet
date_perform datetime Dátum plnenia (YYYY-MM-DD HH:MM:SS)
comment_top string Poznámka viditeľná pre zákazníka
comment_bottom string Interná poznámka
status_id int Identifikátor stavu

POST polia — objekt params (voliteľné)

Pole Typ Povinné Popis
close int 1 = automatické uzavretie po uložení
download int 1 = generovanie PDF po uložení

Príklad požiadavky

POST /api/crm/save
X-API-KEY: {vas_api_kluc}
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
  }
}

Príklad odpovede

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

Odstránenie záznamu CRM. Odstrániť možno iba záznam s otvoreným stavom.

POST polia — objekt data

Pole Typ Povinné Popis
receipt_id int Identifikátor záznamu CRM určeného na odstránenie

Príklad požiadavky

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

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

Príklad odpovede

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

Uzavretie otvoreného záznamu CRM. Uzavrieť možno iba záznam so status_id = 1 (otvorený).

POST polia — objekt data

Pole Typ Povinné Popis
receipt_id int Identifikátor záznamu CRM určeného na uzavretie

Príklad požiadavky

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

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

Príklad odpovede

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

Stiahnutie/generovanie dokumentu záznamu CRM v rôznych formátoch (PDF, base64 reťazec, stream).

Query parametre

Parameter Typ Povinné Popis
receipt_id int Identifikátor záznamu CRM
file_type string Výstupný formát: pdf, pdf-string, stream
language string Názov jazykového priečinka šablóny (napr. hungarian)
template_id int ID vlastnej tlačovej šablóny

Príklad požiadavky

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

Príklad odpovede (file_type=pdf)

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

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Odoslať dopyt

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Pozri sa do centra pomoci

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!
Vytvorenie registrácie
Registrácia