Antes de começar a usar a API, você deve se autenticar para criar uma sessão.
Autenticação:
Existem 2 maneiras de iniciar a sessão:
- Usando sua chave API, detalhes de login e senha;
- Usando sua chave API, detalhes de login e senha criptografada.
Usando sua chave API, detalhes de login e senha
Neste caso, basta utilizar o endpoint POST /session e mencionar a chave da API recebida nas Definições da plataforma no cabeçalho X-CAP-API-KEY, a informação de início de sessão e a palavra-passe da chave da API nos parâmetros identifier e password. O valor do parâmetro encryptedPassword deve ser false.
Usando sua chave API, detalhes de login e senha criptografada
- Em primeiro lugar, deve utilizar o comando GET /session/encryptionKey e mencionar a chave da API gerada nas definições da plataforma no cabeçalho X-CAP-API-KEY. Como resposta, receberá os parâmetros encryptionKey e timeStamp;
- Utilizando os parâmetros encryptionKey e timeStamp recebidos, deve encriptar a palavra-passe da sua chave API utilizando o método de encriptação AES.
- Aceda ao ponto de extremidade POST /session, defina o valor true para o parâmetro encryptedPassword e mencione a chave da API recebida nas definições da plataforma no cabeçalho X-CAP-API-KEY, o início de sessão e as informações anteriores sobre a palavra-passe da chave da API encriptada nos parâmetros identifier e password
Ao iniciar a sessão, você receberá os parâmetros CST e X-SECURITY-TOKEN nos cabeçalhos de resposta. Ambos os tokens devem ser usados nos cabeçalhos de cada solicitação que você está enviando.