Kontakt műveletek

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

 

A MiniCRM-ben tárolt cégek és kapcsolattartók Contactként jelennek meg az API esetén.

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

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

$ curl https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Contact?Email=kjozsef@teszt.hu

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/Contact?Email=kjozsef@teszt.hu&Type=Person

Példa válasz:

{
  "Count": 1,
  "Results": {
    "12345": {
      "Id": "12345",
      "Name": "Kovács József",
      "Url": "https://r3.minicrm.hu/Api/R3/Contact/12345",
      "Type": "Person",
      "Email": "kjozsef@teszt.hu",
      "Phone": "0612345678"
    }
  }
}

Emellett keresni is tudsz kontakok között

Kontakt letöltése

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

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

Egy kiválasztott kontakt adatainak lekérdezése.

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

Példa válasz cég esetén:

{
  "Id": 12346,
  "Type": "Cég",
  "Name": "Teszt Cég",
  "Email": "info@teszt.hu",
  "EmailType": "",
  "Phone": "06-1 / 987-65432",
  "PhoneType": "",
  "Description": "",
  "Url": "http://teszt.hu",
  "Industry": "",
  "Region": "",
  "VatNumber": "",
  "RegistrationNumber": "",
  "BankAccount": "12345678-12345678-12345678",
  "Swift": "",
  "Employees": 0,
  "YearlyRevenue": 0
}

Példa válasz személy esetén:

{
  "Id": 12345,
  "BusinessId": 12346,
  "Type": "Személy",
  "FirstName": "József",
  "LastName": "Kovács",
  "Email": "kjozsef@teszt.hu",
  "EmailType": "",
  "Phone": "0612345678",
  "PhoneType": "",
  "Position": "IT"
}

Kontakt adatmódosítás

Meglévő kontakt 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/Contact/12345 -d '{
 "FirstName":"Kiss",
 "LastName":"Attila"
}'

A szolgáltatás URL megegyezik a kontakt letöltés URL-jével. GET kéréssel kontakt letöltés kezdeményezhető, PUT kéréssel pedig adatmódosítás. Új kontakt felvétele az azonosító kihagyásával lehetséges (példa url végén található 12345 lehagyása). Fontos itt megjegyezni, hogy új kontakt esetén a Type mező küldése kötelező, meglévő kontakt esetén pedig a Type mező már nem szerkeszthető! Amennyiben egy személyt egy céghez szeretnénk rendelni, a BusinessId mezőben a cég azonosítóját megadva lehet ezt megtenni.

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

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

{
  "Id":12345
}