Obter chaves da Api e realizar autenticação.
Para começar sua integração com a gente você vai precisar de uma Chave de API (api_key) que é obtida através do Backoffice Cyclopay ou Backoffice Cyclopay Sandbox e pronto! Com a api_key em mãos você já pode começar a usar todos os recursos disponíveis para realizar suas vendas recorrentes.
Obter Chaves da API
Após obter seu acesso a plataforma, as chaves da API podem ser obtidas através do Backoffice Cyclopay ou Backoffice Cyclopay Sandbox.
Para obter as suas chaves, basta acessar o menu lateral em Empresa, depois Configurações Avançadas.
As chaves estarão disponíveis na seção Chave de API.
Visualização das chaves de APIPor padrão, as chaves ficarão oculto após a primeira utilização.
Caso você esqueceu ou não tenha disponível, basta criar uma nova utilização o botão a direita Redefinir.
Atenção ao redefinir a chave da APIAo solicitar a redefinição da chave da API, a antiga será permanente excluída. Portanto certifique em atualizar as chaves na sua integração.
Em caso de perda da sua chave você deve recriá-la e atualizar os sistemas que consomem a API com a nova chave.
Chaves de APIA Chave de Api é uma chave secreta, única e intransferível. A equipe Cyclopay não se responsabiliza pela forma de utilização e administração das chaves fornecidas.
Todas as requisições terão a chave de acesso verificada para garantir que é uma chave válida.
Caso a chave fornecida seja inválida você receberá um código de resposta HTTP 401(Unauthorized).
Autenticação da API
AutenticaçãoAs requisições devem conter a chave de api em seus respectivos HEADERS, através do campo chamado "api_key".