Para autenticar suas requisições na API da Cyclopay, será necessário utilizar uma Chave de API (api_key).

A chave pode ser obtida diretamente pelo BackOffice e será utilizada em todas as chamadas autenticadas da plataforma.

Cada chave é exclusiva por empresa e deve ser enviada em todas as operações que exigem autenticação.

Obter Chaves da API

Após receber acesso à plataforma, suas credenciais poderão ser consultadas diretamente pelo BackOffice Cyclopay.

📘
Como localizar sua chave:

Acesse o BackOffice correspondente ao ambiente desejado.

No Menu a esquerda, Navegue até Empresa.

Selecione Configurações Avançadas.

Localize a seção Chave de API.

Copie a credencial para utilização em sua integração.

🚧
Visualização da chave:
Por motivos de segurança, a chave ficará oculta após sua primeira utilização.
Caso seja necessário gerar uma nova credencial, utilize a opção Redefinir disponível na mesma tela.

❗️
Redefinição da chave:
Ao redefinir uma chave de API, a credencial anterior será invalidada imediatamente.
Após gerar uma nova chave, atualize todas as aplicações, servidores, integrações e automações que utilizam a credencial antiga.
A chave anterior não poderá ser recuperada.
A Cyclopay não possui acesso às credenciais armazenadas em seus sistemas e não se responsabiliza pelo uso indevido de chaves expostas ou compartilhadas.

Autenticação da API

A autenticação é realizada através do cabeçalho api_key.

Todas as requisições devem incluir a chave correspondente ao ambiente utilizado.

Exemplos

curl --request GET \
  --url https://gateway-sandbox.cyclopay.com/v1/charges \
  --header 'api_key: SUA_API_KEY'

GET /v1/charges HTTP/1.1
Host: gateway-sandbox.cyclopay.com
api_key: SUA_API_KEY

Boas práticas

Nunca exponha sua chave no frontend.
Nunca publique sua chave em repositórios Git.
Utilize variáveis de ambiente.
Restrinja o acesso às credenciais.
Revogue imediatamente chaves comprometidas.

Próximos passos

👍
Após configurar sua autenticação, você já pode iniciar a integração utilizando os recursos da API.
Recomendamos começar pela criação de uma transação de teste no ambiente Sandbox para validar o fluxo completo de comunicação entre sua aplicação e a plataforma.