Mielőtt elkezdené használni az API-t, hitelesítenie kell magát a munkamenet létrehozásához.
Hitelesítés:
Két módon indíthatja el a munkamenetet:
- Az API kulcs, bejelentkezési név és jelszó használatával;
- Az API kulcs, bejelentkezési név és titkosított jelszó használatával.
Az API kulcs, bejelentkezési név és jelszó használatával
Itt egyszerűen a POST /session végpontot kell használnia, és a platform Beállítások menüjében kapott API kulcsot meg kell adnia az X-CAP-API-KEY fejlécben, a bejelentkezési nevet és az API kulcs jelszót pedig az identifier és password paraméterekben. Az encryptedPassword paraméter értéke legyen false.
Az API kulcs, bejelentkezési név és titkosított jelszó használatával
- Először a GET /session/encryptionKey végpontot kell használnia, és a platform Beállítások menüjében kapott API kulcsot megadnia 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 titkosítania kell az API kulcs jelszavát az AES titkosítási módszerrel.
- Ezután lépjen a POST /session végpontra, á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 az előzőleg titkosított API kulcs jelszót az identifier és password paraméterekben.
A munkamenet elindítása után a válasz fejlécében megkapja a CST és X-SECURITY-TOKEN paramétereket. Mindkét token-t minden elküldött kérés fejlécében használni kell.