API Reference

Habilitar mTLS em produção

O mTLS adiciona uma camada extra de segurança além das credenciais de API, garantindo que o tráfego entre o cliente e o servidor seja seguro e confiável em ambas as direções. Essa medida reflete o compromisso da Transfeera em proteger as suas operações.

➡️

Atualmente, o mTLS está disponível apenas em produção.

Para acessar o ambiente de sandbox utilize os DNS:

Pagamentos e Recebimentos: https://api-sandbox.transfeera.com

Conta Certa: https://contacerta-api-sandbox.transfeera.com

Mais informações sobre Sandbox aqui.

Para habilitar o mTLS em produção será necessário incluir o domínio e adicionar os certificados na chamada do seu client.

Os domínios mTLS são prefixados com .mtls, ficando assim:

  • api.mtls.transfeera.com
  • login-api.mtls.transfeera.com
  • contacerta-api.mtls.transfeera.com

Para começar, gere um CSR (Certificate signing request) public.csr, o que também criará uma chave privada (private.key). Essa chave nunca deve ser compartilhada, e deve ser armazenada de forma segura no seu ambiente, pois será necessária para fazer as chamadas.

Para gerar o CSR usando OpenSSL, execute:

openssl req -new -newkey rsa:2048 -nodes -keyout private.key -out public.csr

Preencha as informações abaixo com os dados da sua empresa:

Country Name (2 letter code) []: BR
State or Province Name (full name) []: Estado
Locality Name (eg, city) []: Cidade
Organization Name (eg, company) []: Minha empresa LTDA
Organizational Unit Name (eg, section) []: Minha empresa LTDA
Common Name (eg, fully qualified host name) []: Minha empresa LTDA
Email Address []: [email protected]

Após isso, entre em contato com o nosso Suporte solicitando a habilitação do mTLS para a sua conta e anexe o arquivo public.csr.

🚧

Importante: Nunca compartilhe a sua chave privada.

Após a configuração por nossa parte, você receberá um link para baixar seu certificado (*.crt). Esse certificado deve ser usado em conjunto com a chave privada (private.key.) gerada anteriormente.

Para testar a chamada e garantir que está tudo certo, você deve conseguir realizar este curl com sucesso:

curl --cert certificate.crt --key private.key https://api.mtls.transfeera.com/status

Caso você tenha algum erro na sua integração, receberá este erro HTTP com o código: 403:

{
    "error": "Forbidden",
    "statusCode": 403,
    "message": "mTLS required"
}

Verifique que está enviando corretamente o certificado e a chave privada na sua requisição e usando os domínios mTLS. Em caso de dúvidas, contate o nosso suporte para auxiliá-lo.

Caso você já esteja integrado

Caso você já esteja integrado com a nossa API, sem fazer uso do mTLS, será necessário realizar a migração.

Nosso time está preparado para auxiliar na migração de forma que não aconteçam interrupções.

O processo é o seguinte:

  1. Gere o arquivo CSR e envie para nós, conforme instruções acima.

🚧

Importante: Nunca compartilhe a sua chave privada.

  1. Você receberá o Certificado para download.
  2. Sua integração continua funcionando normalmente.
  3. Faça os ajustes necessários na sua integração:
    1. Altere os endpoints para prefixar .mtls conforme mencionado acima.
    2. Inclua o certificado e chave privada em todas as requisições no seu client.
  4. Assim que tudo estiver funcionando, notifique o time de Suporte que realizou a migração.
  5. Nossa equipe desativará o fluxo sem mTLS para sua conta, e os endpoints sem mTLS deixarão de funcionar.

Em caso de dúvida, conte com o nosso time de Suporte para lhe auxiliar.

Lembre-se que a migração é importante para aumentar a segurança da comunicação entre seu sistema e a Transfeera.