MiniCRM API
A MiniCRM API használatának feltétele Professional, vagy Enterprise MiniCRM platform, illetve a MiniCRM REST APIs + XML szinkronizáció nevű kiegészítő.
Abban az esetben, hogyha még nincs bekapcsolva ez a kiegészítő, a rendszereden belül van lehetőséged ezt megtenni:
- A Beállítások — Előfizetés opcióra kattintva tudod bepipálni a MiniCRM REST APIs + XML szinkronizáció kiegészítőt.
A legfrissebb MiniCRM API dokumentációnk az alábbi linken érhető el Angol nyelven:
MiniCRM API documentation (EN)
Korábbi Magyar nyelvű API dokumentáció:
A MiniCRM nyílt, a benne rögzített adatok MiniCRM API-n keresztül elérhetőek más programok számára, és azokkal a meglévő adatokat módosíthatod, bővítheted.
A MiniCRM API egy egyszerű felület, ami használható bármilyen programozási nyelvből (Javascript, PHP, C#, C, Java, stb…). A használat feltétele, hogy a programot futtató számítógép rendelkezzen működő internetkapcsolattal, el tudja érni a MiniCRM API-t, valamint a program rendelkezzen érvényes MiniCRM rendszerrel, és hozzá tartozó API kulccsal.
Azonosítás szabványos http azonosítással “HTTP Auth” történik.
Az azonosításhoz szükséges
- felhasználói rendszer azonosító (továbbiakban SystemId, azaz a böngésző címsorában az r3.minicrm.hu/ után látható, maximum 5 jegyű szám)
- és API kulcs (továbbiakban API-Key), amit adminisztrátor jogosultságú felhasználóként tudsz igényelni a Beállítások > Rendszer képernyőn. Ehhez az Új API kulcs készítése gombra kell kattintani. Ha már generáltál API kulcsot, lehetőséged van újat generálni, vagy törölni a meglévőt.
A MiniCRM API használható “HTTP Secure” kapcsolaton keresztül is a https:// előtag használatával.
MiniCRM API Url:
https://SystemId:APIKey@r3.minicrm.hu/Api/R3
Kódlap
A MiniCRM API az UTF-8 kódlapot használja. Minden bejövő paramétert UTF-8 kódolásban vár és minden választ UTF-8 kódlapon ad.
Formátum
Bemeneti és kimeneti adatformátum minden esetben JSON serialized tömb.
Limitáció
R3 API végpontunkon 60 request / perc rate limitáció van életben. Minden ezt meghaladó kérés 429-es „Too many requests” válasszal elutasáításra kerül.
Elérhető szolgáltatások
- Termékek és sémák lekérése
- Adatlapok létrehozása, lekérése, módosítása
- Kontaktok létrehozása, lekérése, módosítása
- Teendők létrehozása, lekérése, módosítása
- Címek létrehozása, lekérése, módosítása
- Sablonok lekérése, módosítása
- Keresés
- Hibaüzenetek kezelése
- Példaprogramok
- Számlázó példaprogram
- Külső azonosító (ReferenceId) használata
- Számla adatainak lekérdezése
- Számla kiállítása, sztornózása, fizetettre állítása
- Űrlap beküldése