Adatlap műveletek

A legfrissebb MiniCRM API dokumentációnk az alábbi linken érhető el:
http://cdn.minicrm.hu/media/MiniCRM-Api-Hungarian.pdf

A MiniCRM-ben tárolt adatlapok Project-ként jelennek meg az API-n.

Mező alapú keresés  Projektek között

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

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Project?StatusId=2500

Ennél a lehetőségnél egyes mezők értékeire végezhetünk kereséseket. Fontos itt megjegyezni, hogy a szűrés azokra a mezőkre is működik, amelyek nem találhatók a keresés eredményében. A mezők lehetséges értékeiről a Sémák lekérése pontban olvashatsz bővebben. Amennyiben részletesebb szűrést szeretnénk, több mező is megadható paraméterként, pl:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Project?StatusId=2500&UserId=3200

Mező alapú projekt keresésnél használható egy speciális paraméter is, amivel az adott státuszcsoportban található projektek kérhetőek le. A feltétel StatusGroup néven érhető el és a következő értékei lehetnek: Lead, Open, Success, Failed. Pl:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Project?StatusGroup=Success

Példa válasz:

{
  "Count": 1,
  "Results": {
    "1234": {
      "Id": "1234",
      "Name": "Teszt projekt",
      "Url": "https://r3.minicrm.hu/Api/R3/Project/1234",
      "StatusId": "2500",
      "UserId": "3200",
      "Deleted": "0"
    }
  }
}

Projekt letöltése

Projekt a rendszerből kétféleképpen kérhető le, ProjectId (adatlap azonosító) és ReferenceId (külső rendszer azonosító) alapján.

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

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

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

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Project?ReferenceId=123456

A válasz mindkét esetben ugyanaz, egy kiválasztott projekt adatainak lekérdezése.

Válaszban a projekt egy tömbben érkezik, ahol megtalálhatóak a projekt mezőinek adatai.

Példa válasz:

{
  "Id": 1234,
  "CategoryId": 3,
  "ContactId": 12345,
  "StatusId": "Igényfelmérés",
  "UserId": "Keszei Csaba",
  "Name": "Kovács József első vásárlás",
  "Deleted": "0",
  "Enum1016": "Ismerős ajánlotta",
  "Set1035": "Alap termék",
  "Text1105": "Egy szöveges mező ami ki van töltve",
  "Int1107": 12500,
  "File1103": "http://cdn.minicrm.hu/doc/2013/04-25/A/Q/AQFwQq7Os0kE5ykH_GSJfg-1"
}

Projekt adatmódosítás

Meglévő projekt módosítása, vagy új létrehozása. Célszerű csak a módosult adatokat újraküldeni, így hatékonyabban futhatnak a programok, elkerülhető az időközben már módosult adatok visszaállítása korábban letöltött értékekre. Azonosítás szükséges, példa url:

$ curl -XPUT https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Project/1234 -d '{
 "Name":"Átnevezett projekt",
 "Deleted":"1"
}'

A szolgáltatás URL megegyezik a projekt letöltés URL-jével. GET kéréssel projekt letöltés kezdeményezhető, PUT kéréssel pedig adatmódosítás. Új projekt felvétele az azonosító kihagyásával lehetséges (példa url végén található 1234 lehagyása). Fontos itt megjegyezni, hogy új projekt esetén a CategoryId és ContactId mező küldése kötelezőmeglévő projekt esetén a CategoryId és ContactId mező pedig már nem szerkeszthető!

Fájl típusú mezők esetén rendszerünk egy Url-t vár, ahol megtalálható a feltölteni kívánt fájl. Ilyen típus esetén a fájl áttöltésre kerül a MiniCRM szervereire és ott tárolásra kerül.

Amennyiben saját rendszeredben létezik azonosító, amelyet szeretnél rögzíteni rendszerünkben, a ReferenceId nevű mező segítségével rögzítheted!

Bemeneten várt adatstruktúra megegyezik a projekt letöltéskor kapott struktúrával. Bemeneti formátum JSON serialized tömb.

Példa válasz sikeres mentés esetén:

{
  "Id":1234
}

Emailek listázása

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

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

Egy kiválasztott projekt emailjeinek lekérdezése.

A válaszban a találatok egy tömbben érkeznek, melynek Count kulcsán található a talált sablonok száma. A Results kulcs alatt egy-egy külön tömbben találhatóak a projekt emailjei.

A keresés szűkíthető a CreatedAt paraméter segítségével. Ilyenkor csak azok az emailek kerülnek listázásra, amelyek az adott időpontban vagy az után kerültek rögzítésre a rendszerben. Példa:

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/EmailList/1234?CreatedAt=2014-03-20

FONTOS! Amennyiben rendszerünkből nagy darabszámú email kiküldéseket végzel, ezek a lekérdezek hosszabb időt vehetnek igénybe!

Az emailekhez a letöltési funkció jelenleg nem támogatott!

Példa válasz:

{
   "Count":1,
   "Results":[
      {
         "Id":3333,
         "TemplateId":1479,
         "From":"help@minicrm.hu",
         "To":"user@example.com",
         "Subject":"Kiküldött email tárgya",
         "Status":"Sent",
         "CreatedAt":"2013-03-20 12:35:24",
         "OpenedAt":"2013-03-20 15:12:00",
         "ClickedAt":""
      }
   ]
}