Modulok és sémák lekérése

A legfrissebb MiniCRM API dokumentációnk az alábbi linken érhető el:
MiniCRM Api Dokumentáció

Modulok lekérése

Azonosítás szükséges, példa url:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Category

Ezzel a funkcióval a rendszerben található összes aktív – azaz nem Lomtárban lévő – modult és a hozzátartozó azonosítókat lehet lekérdezni.

Példa válasz:

{
  "3": "Értékesítés",
  "5": "Ügyfélszolgálat",
  "6": "Projektek",
  "8": "Számlázó"
}

Modulok adatainak részletes lekérése

Azonosítás szükséges, példa url:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Category?Detailed=1

Ezzel a funkcióval a rendszerben található összes aktív – azaz nem Lomtárban lévő – modult és a hozzátartozó részletes adatokat lehet lekérdezni.

Példa válasz:

{
    "3": {
        "Id": 1,
        "OrderId": 1,
        "Name": "Értékesítés",
        "Type": "Generic",
        "SenderName": "Test User",
        "SenderEmail": "test.user@minicrm.local",
        "Phone": 36201234567
    },
    "5": {
        "Id": 2,
        "OrderId": 3,
        "Name": "Ügyfélszolgálat",
        "Type": "HelpDesk",
        "SenderName": "Test User",
        "SenderEmail": "test.user@minicrm.local",
        "Phone": ""
    },
    "6": {
        "Id": 3,
        "OrderId": 5,
        "Name": "Projektek",
        "Type": "Generic",
        "SenderName": "Test User",
        "SenderEmail": "test.user@minicrm.local",
        "Phone": ""
    },
    "8": {
        "Id": 8,
        "OrderId": 4,
        "Name": "Számlázó",
        "Type": "Invoice",
        "SenderName": "Test User",
        "SenderEmail": "test.user@minicrm.local",
        "Phone": 36301234567
    }
}

Sémák lekérése

Azonosítás szükséges, példa url:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Schema/Business

Sémával lekérhetőek a rendszerben található mezők és a hozzájuk tartozó értékek. Ezek alapján meg lehet határozni, hogy egy adott mezőtípus milyen értékekkel tölthető fel. Három sémát lehetséges lekérni a rendszerben, mely az Url végén található Project átírásával változtatható. Lehetséges értékei: Project, Business, Person. Projekt típusú sémák a modulok különböző mezői miatt csak a modul meghatározásával kérhetőek le, pl:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Schema/Project/3

A mezők típusok szerint a következő módon tölthetőek fel API-n keresztül:

  • CategoryId: Modul azonosító (pl. 3)
  • ContactId: Kontakt azonosító (pl. 12345)
  • StatusId: Státusz azonosító vagy státusz név (pl. 2500 vagy ‘Igényfelmérés’)
  • UserId: Felhasználó azonosító vagy felhasználónév (pl. 3200 vagy ‘Keszei Csaba’)
  • BusinessId: Kontakt azonosító (pl. 12345)
  • Deleted: 0 vagy 1 (törölt vagy sem)
  • Int: Egész szám (pl. 125)
  • Text: Szöveg (pl. ‘Ez egy példa szöveg’)
  • DateTime: Dátum és Idő vagy Dátum (pl. ‘2013-05-25 13:12:00’ vagy ‘2013-05-25’)
  • File: Feltöltendő fájl Url-je (pl. ‘http://www.minicrm.hu/tesztfajl.xls’)
  • Enum: Érték azonosító vagy Érték neve (pl. 1740 vagy ‘Kiállítás’)
  • Set: Érték maszkok összege vagy Értékek vesszővel elválasztva (pl. 6 vagy ‘Kiegészítő termék,Prémium termék’)

Példa válasz:

{
  "Id": "Int",
  "CategoryId": {
    "3": "Értékesítés",
    "5": "Ügyfélszolgálat",
    "6": "Projektek",
    "8": "Számlák"
  },
  "ContactId": "Int",
  "StatusId": {
    "2509": "Rendelés teljesítése",
    "2500": "Igényfelmérés",
    "2512": "Elvesztett vevő",
    "2540": "Ajánlatkészítés",
    "2541": "Ajánlat utánkövetés",
    "2543": "Továbbajánlás kérése",
    "2544": "Nem nyert ajánlat",
    "2545": "Elérhetetlen",
    "2546": "Visszajelzések gyűjtése",
    "2547": "Időpontegyeztetés",
    "2548": "Szerződéskötés",
    "2549": "Nem érdekli",
    "2552": "Lezárt rendelés",
    "2575": "További eladás",
    "2577": "Személyes találkozó"
  },
  "UserId": {
    "3200": "Keszei Csaba",
  },
  "Name": "Text(128)",
  "Deleted": "Boolean",
  "Int1107": "Int",
  "DateTime1106": "DateTime",
  "File1113": "File(10MB)",
  "Text1105": "Text(1024)",
  "Enum1016": {
    "1253": "Hideghívás",
    "1254": "Ismerős ajánlotta",
    "1255": "Google",
    "1256": "Más weboldalon látott hivatkozás",
    "1257": "Viszonteladó",
    "1335": "Egyéb",
    "1340": "Kiállítás"
  },
  "Enum1033": {
    "1328": "Ideális ügyfél",
    "1329": "Lehet ügyfél",
    "1330": "Nem célcsoport"
  },
  "Set1035": {
    "1": "Alap termék",
    "2": "Kiegészítő termék",
    "4": "Prémium termék"
  }
}