SalesAutopilot APIv2

A fejlesztőknek szánt dokumentáció továbbfejlesztéseként elérhetővé vált a SalesAutopilot APIv2 dokumentáció egyes funkciócsoportokhoz kapcsolódóan. Az új felület könnyebben kezelhető, áttekinthetőbb, és lehetőséget biztosít az azonnali tesztelésre is.

A korábbi bejegyzésekben elérhető leírások képezik a SalesAutopilot APIv1 dokumentációnkat. Fejlesztőink folyamatosan dolgoznak a korábbi dokumentációban elérhető végpontok, metódusok APIv2-re történő frissítésén. Ebben a bejegyzésben érhetőek el azok a funkciócsoportok, amelyekhez már elérhető az APIv2 dokumentáció.

Fontos: Az APIv1 és APIv2 verzió között működésbeli különbségek is vannak, ezért ezek a verziók most egymás mellett léteznek. Mindkettő verzió alkalmazható még, azonban az APIv1 idővel kivezetésre fog kerülni, ezért a későbbiekre tekintve az APIv2 alkalmazását javasoljuk.

Funkciók, amelyeknek már elérhető az APIv2-es verziója:

• Űrlapmező hozzáadás, törlése, űrlapmezők listázása
• Globális változók létrehozása, lekérdezése, frissítése

SalesAutopilot APIv2 dokumentáció felépítése & használata

1. A bal oldali sávban láthatóak a már elérhető APIv2-es végpontok, metódusok.
2. Bármelyikre kattintva megjelennek a részletes adatok és a lap tetején látható a végpont neve, elérése, leírása.
3. A jobb oldali sávban kiválasztható a programozási nyelv a három pont ikonra kattintva, amiben szeretnénk legenerálni a kódot.
4. Autentikációs adatok a teszteléshez (SalesAutopilot felületén létrehozott API kulcs szükséges hozzá).
5. A generált kód helye. Az adatok megadása után a jobb alsó sarokban a "Try it!" gombbal tesztelhető a működés, illetve a bal alsó sarokban lévő ikonnal lehet másolni a generált kódot.
6. A végpont meghívása után kapott válasz felépítése és a benne szereplők adatok magyarázata.

7. Hiba esetén a visszakapott hibaüzenet felépítésének leírása.
8. Az adott végpont esetén lehetséges hibajelzések részletes magyarázata.
9. Teszteléshez szükséges paraméterek megadásának helye.
10. Lehetséges válaszok. Lenyitva az egyes válaszokat megtekinthető, hogy pontosan milyen lesz a válasz felépítése.
11. Ha végig futott egy tesztelés, akkor jobb alul megjelenik a konkrét teszt eredménye is.

Kapcsolódó bejegyzések

• API kulcspárok kezelése
• Kapcsolódás az API-hoz