Prima di iniziare a usare l'API, è necessario autenticarsi per creare una sessione.
Autenticazione:
Ci sono due modi per avviare la sessione:
- Utilizzando la chiave API, i dati di login e la password;
- Utilizzando la chiave API, i dati di login e la password crittografata.
Utilizzando la chiave API, i dati di login e la password
In questo caso è sufficiente utilizzare l'endpoint POST /session e indicare la chiave API ricevuta nelle impostazioni della piattaforma nell'intestazione X-CAP-API-KEY, le informazioni sulla login e sulla password della chiave API nei parametri identifier e password. Il valore del parametro encryptedPassword deve essere false.
Utilizzando la chiave API, i dati di login e la password crittografata
- Per prima cosa si deve utilizzare il comando GET /session/encryptionKey e indicare la chiave API generata nelle impostazioni della piattaforma nell'intestazione X-CAP-API-KEY. In risposta si riceveranno i parametri encryptionKey e timeStamp;
- Utilizzando i parametri encryptionKey e timeStamp ricevuti, si deve crittografare la password della chiave API utilizzando il metodo di crittografia AES.
- Andare all'endpoint POST /session, impostare il valore true per il parametro encryptedPassword e indicare la chiave API ricevuta nelle impostazioni della piattaforma nell'intestazione X-CAP-API-KEY, il login e le informazioni sulla password della chiave API precedentemente crittografata nei parametri identifier e password.
All'avvio della sessione si riceveranno i parametri CST e X-SECURITY-TOKEN nelle intestazioni di risposta. Entrambi questi token devono essere utilizzati nelle intestazioni di ogni richiesta inviata.