Antes de começar a usar a API, você deve autenticar-se para criar uma sessão.
Autenticação:
Existem 2 maneiras de iniciar a sessão:
- Usando sua chave API, login e detalhes da senha;
- Usando sua chave API, login e detalhes da senha criptografada.
Usando sua chave API, login e detalhes da senha
Aqui você deve simplesmente usar o endpoint POST /session e mencionar a chave API recebida nas Configurações da plataforma no cabeçalho X-CAP-API-KEY, o login e a senha da chave API nos parâmetros identifier e password. O valor do parâmetro encryptedPassword deve ser false.
Usando sua chave API, login e detalhes da senha criptografada
- Primeiramente, você deve usar o GET /session/encryptionKey e mencionar a chave API gerada nas Configurações da plataforma no cabeçalho X-CAP-API-KEY. Como resposta, você receberá os parâmetros encryptionKey e timeStamp;
- Usando os parâmetros encryptionKey e timeStamp recebidos, você deve criptografar sua senha da chave API usando o método de criptografia AES.
- Vá para o endpoint POST /session, defina o valor true para o parâmetro encryptedPassword e mencione a chave API recebida nas Configurações da plataforma no cabeçalho X-CAP-API-KEY, o login e a senha da chave API criptografada nos parâmetros identifier e password.
Ao iniciar a sessão, você receberá os parâmetros CST e X-SECURITY-TOKEN nos cabeçalhos da resposta. Ambos os tokens devem ser usados nos cabeçalhos de cada requisição que você enviar.