Informații despre produse și structură

Preluarea produselor

Pentru această acțiune este necesară autentificarea:

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

Această funcționalitate este folosită pentru a interoga produsele active din sistem și a id-urilor acestora (produsele aflate în coșul de gunoi nu vor apărea în rezultatele acestei interogări).

Exemplu de răspuns:

{
  "3": "Vânzări",
  "5": "Helpdesk",
  "6": "Proiecte",
  "8": "Facturare"
}

Preluarea datelor legate de detaliile produselor

Este necesară autentificarea:

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

Această funcționalitate îți permite să interoghezi toate produsele active (cele din Coșul de gunoi sunt excluse) și să preiei detaliile acestora.

Exemplu de răspuns:

{
    "3": {
        "Id": 1,
        "OrderId": 1,
        "Name": "Vânzări",
        "Type": "Generic",
        "SenderName": "Test User",
        "SenderEmail": "test.user@minicrm.local",
        "Phone": 36201234567
    },
    "5": {
        "Id": 2,
        "OrderId": 3,
        "Name": "Helpdesk",
        "Type": "HelpDesk",
        "SenderName": "Test User",
        "SenderEmail": "test.user@minicrm.local",
        "Phone": ""
    },
    "6": {
        "Id": 3,
        "OrderId": 5,
        "Name": "Proiecte",
        "Type": "Generic",
        "SenderName": "Test User",
        "SenderEmail": "test.user@minicrm.local",
        "Phone": ""
    },
    "8": {
        "Id": 8,
        "OrderId": 4,
        "Name": "Facturare",
        "Type": "Invoice",
        "SenderName": "Test User",
        "SenderEmail": "test.user@minicrm.local",
        "Phone": 36301234567
    }
}

Preluarea structurii unui produs

Este necesară autentificarea:

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

Această funcționalitate îți permite să preiei structura de câmpuri, valorile și tipul de date ale acestora pentru un anumit produs.

În sistem există trei scheme predefinite și pentru a le accesa este nevoie de modificarea adresei URL, iar acestea sunt Project, Business și Person.

Exemplu:

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

Tipuri de câmpuri:

• CategoryId: Id-ul produsului (de exemplu, 3)
• ContactId:  Id-ul unui contact (de exemplu, 12345)
• StatusId:  Id-ul statusului sau denumirea acestuia (de exemplu, 2500 sau ‘Definire nevoi’)
• UserId:  Id-ul utilizatorului sau numele lui (de exemplu, 3200 sau ‘Bogdan Burciu’)
• BusinessId:  Id-ul companiei (de exemplu, 12345)
• Deleted:  0 sau 1 (șters sau nu)
• Int:  Număr întreg (de exemplu, 125)
• Text:  Șir de caractere (de exemplu, ‘Acesta este un exemplu de text’)
• DateTime:  Data și timpul sau doar data – format AAAA-LL-ZZ OO:MM:SS (A=an; L=luna; Z=ziua; O=ora; M=minut; S=secundă –  (de exemplu, ‘2013-05-25 13:12:00’ sau ‘2013-05-25’)
• File:  URL-ul unui fișier (de exemplu, ‘http://www.minicrm.hu/testfile.xls’)
• Enum:  Id-ul valorii sau denumirea (de exemplu, 1740 sau ‘Expoziție’)
• Set:  Suma valorilor sau valorile separate prin virgulă (de exemplu, 6 sau ‘articol 1, articol 2’)

Exemplu de răspuns:

{
  "Id": "Int",
  "CategoryId": {
    "3": "Vânzări",
    "5": "Helpdesk",
    "6": "Proiecte",
    "8": "Facturare"
  },
  "ContactId": "Int",
  "StatusId": {
    "2509": "Comandă înregistrată",
    "2500": "Definire nevoie",
    "2512": "Client pierdut",
    "2540": "Ofertare",
    "2541": "Follow-up ofertă",
    "2543": "Solicitare feedback",
    "2544": "Ofertă pierdută",
    "2545": "Nerealizabil",
    "2546": "Colectare feedback",
    "2547": "Întâlnire",
    "2548": "Contractare",
    "2549": "Neinteresat",
    "2552": "Închidere comandă",
    "2575": "Vânzare nouă",
    "2577": "Întâlnire personală"
  },
  "UserId": {
    "3200": "Bogdan Burciu",
  },
  "Name": "Text(128)",
  "Deleted": "Boolean",
  "Int1107": "Int",
  "DateTime1106": "DateTime",
  "File1113": "File(10MB)",
  "Text1105": "Text(1024)",
  "Enum1016": {
    "1253": "Cold call",
    "1254": "Recomandare",
    "1255": "Google",
    "1256": "Website",
    "1257": "Client existent",
    "1335": "Altele",
    "1340": "Expoziție"
  },
  "Enum1033": {
    "1328": "Client ideal",
    "1329": "Potențial client",
    "1330": "Nu face parte din grupul targetat"
  },
  "Set1035": {
    "1": "articol de bază",
    "2": "articol complementar",
    "4": "articol premium"
  }
}