Interogarea și modificarea contactelor

Companiile și persoanele de contact înregistrate în MiniCRM vor fi afișate ca și Contacte (Contacts) în API.

Căutarea pe baza un contact

Este necesară autentificarea:

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

Această funcționalitate îți permite să cauți după valorile unor câmpuri. Pentru mai multe informații legate de valorile câmpurilor, consultă pagina legată de preluarea produselor și a structurii acestora. În căutare, poți specifica mai multe câmpuri ca și parametri:

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

Exemplu de răspuns:

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

Poți căuta și un anumit Contact specificând-ui Id-ul:

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

Interogare va afișa detaliile contactului al cărui Id a fost specificat.

În răspuns, detaliile contactului vor fi afișate sub forma unui array care va conține detaliile contactului.

Exemplu de răspuns pentru o companie:

{
  "Id": 12346,
  "Type": "Company",
  "Name": "Test companie",
  "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
}

Exemplu de răspuns pentru o persoană:

{
  "Id": 12345,
  "BusinessId": 12346,
  "Type": "Person",
  "FirstName": "Bogdan",
  "LastName": "Burciu",
  "Email": "bogdan.burciu@minicrm.ro",
  "EmailType": "",
  "Phone": "01234567890",
  "PhoneType": "",
  "Position": "Consultant CRM"
}

Crearea unui contact (Companie/Contact) nou

Pentru crearea unei noi companii:

curl -XPUT https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Contact -d '{
"Name": "Numele companiei", 
"Type": "Business",
...
}'

Pentru crearea unui contact:

curl -XPUT https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Contact -d '{
"FirstName": "Prenume", 
"LastName": "Nume", 
"BusinessId": 1234, - OPȚIONAL (vezi detalii mai jos)
"Type": "Person",
...
}'

Pentru creearea contactelor este obligatoriu să fie specificat tipul (Type) – Business pentru companii sau Person pentru persoane.

Dacă ai nevoie să asociezi un contact de o companie, poți face acest lucru folosind parametrul BusinessId și specificând Id-ul respectivei companii.

În ambele cazuri, crearea cu succes a companiei/contactului va returna Id-ul companiei/contactului creat(ă):

{
  "Id":12345
}

Modificarea datelor unui contact

$ curl -XPUT https://SystemId:APIKey@r3.minicrm.hu/Api/R3/Contact/12345 -d '{
 "FirstName":"Bogdan",
 "LastName":"Burciu"
}'

Preluarea datelor poate fi inițializată cu cereri de tip GET iar cele de modificare cu cereri de tip PUT. Adăugarea unui card nou este posibilă prin omiterea identificatorului (1234 în exemplul de URL de mai sus). Dacă dorești să aloci o persoană de contact unei companii poți face acest lucru prin specificarea Id-ul companiei în câmpul BusinessId.

Exemplu de răspuns pentru salvarea cu succes a informațiilor în sistem:

{
  "Id":12345
}