Mielőtt elkezdené használni az API-t, hitelesítenie kell magát egy munkamenet létrehozásához.
Hitelesítés:
Két módja van a munkamenet indításának:
- Az API kulcs, bejelentkezési név és jelszó adatok használatával;
- Az API kulcs, bejelentkezési név és titkosított jelszó adatok használatával.
Itt egyszerűen a POST /session végpontot kell használnia, és meg kell adnia a platform Beállítások menüjében kapott API kulcsot az X-CAP-API-KEY fejlécben, valamint a bejelentkezési és API kulcs jelszó információkat az identifier és password paraméterekben. Az encryptedPassword paraméter értéke legyen false.
- Először a GET /session/encryptionKey végpontot kell használnia, és meg kell adnia a platform Beállítások menüjében generált API kulcsot az X-CAP-API-KEY fejlécben. Válaszként megkapja az encryptionKey és timeStamp paramétereket;
- A kapott encryptionKey és timeStamp paraméterek segítségével AES titkosítási módszerrel titkosítania kell az API kulcs jelszavát.
- Menjen a POST /session végponthoz, állítsa az encryptedPassword paraméter értékét true-ra, és adja meg a platform Beállítások menüjében kapott API kulcsot az X-CAP-API-KEY fejlécben, valamint a bejelentkezési nevet és a korábban titkosított API kulcs jelszót az identifier és password paraméterekben
A munkamenet indításakor a válasz fejléceiben megkapja a CST és X-SECURITY-TOKEN paramétereket. Mindkét tokent minden elküldött kérés fejlécében használnia kell.