Külső rendszerazonosító (ReferenceId) használata

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

 

MiniCRM API képes fogadni külső rendszerazonosítót projektekhez.

Végpont: https://$SystemId:$ApiKey@r3.minicrm.hu/Api/SyncFeed/$SystemId/SetReferenceId

Fenti hivatkozásra kell a rendszerhez tartozó API kulccsal Authentikálva POST-olni References nevű változóban egy JSON tömböt, ami a ProjectId-ket tartalmazza kulcsnak és a ReferenceId-k az értékek.

Példa:

$ curl https://$SystemId:$ApiKey@r3.minicrm.hu/Api/SyncFeed/$SystemId/SetReferenceId --data 'References={"12":123456788,"13":123456789}'

A fenti parancs a 12 & 13-as MiniCRM-es Id-jű projektekre állítja be a kapott külső azonosítókat.

Json tömbben a kulcs string-ként szerepeljen (érték lehet szám). Php json_encode-ja olyan outputot ad vissza, amit az API elfogad.

Projekt keresése ReferenceId alapján:

Projekt a rendszerből nem csak ProjectId (adatlap azonosító) alapján kérhető le, lehetőség van a beállított ReferenceId (külső rendszer azonosító) használatára is.

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

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

A válasz a keresett 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 tétel",
  "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"
}

 

Contact (kapcsolattartó, cég ) Reference Id

MiniCRM API-n keresztül lehetőség van Contact (személy, cég) külső rendszerazonosító kapcsolására.

A végpont a project típusú Reference Id-hoz hasonló:

„https://$SystemId:$ApiKey@r3.minicrm.hu/Api/SyncFeed/$SystemId/SetReferenceId”

Fenti hivatkozásra kell a rendszerhez tartozó API kulccsal Authentikálva POST-olni JSON bodyba:

Type : „Business” (cég), Type: „Person” (magánszemély) References nevű változóban egy JSON tömböt, ami a ProjectId-ket tartalmazza kulcsnak és a ReferenceId-k az értékek.