Saiba como autenticar suas requisições para a API do Sinky Consulta em ambiente de produção, utilizando chaves de API exclusivas e seguindo as melhores práticas de segurança
🔐 Autenticação para Produção
A autenticação garante que apenas aplicações autorizadas possam interagir com os serviços do Sinky Consulta. Nesta seção, explicamos como utilizar sua chave de API para habilitar o acesso seguro ao ambiente de produção.
⚙️ Como funciona a autenticação
Para acessar a API do Sinky Consulta em ambiente de produção, é necessário autenticar suas requisições utilizando uma chave de API exclusiva.
- A autenticação é feita via header HTTP
x-api-key. - Essa chave é fornecida pela equipe da Sinky durante o processo de onboarding ou mediante solicitação.
- Todas as requisições enviadas para os endpoints de produção devem conter essa chave no header para serem autorizadas.
📄 Exemplo de uso
Exemplo de requisição autenticada:
POST https://gateway.besinky.com/public-api/studio/workflow/{workflowId}/test
x-api-key: sua_chave_de_producao
Content-Type: application/json🔑 Obtenção da chave de produção
Para receber sua chave de API de produção, entre em contato com a equipe da Sinky pelo e-mail:
Nosso time validará sua solicitação e enviará as credenciais de forma segura.
🛡️ Boas práticas de segurança
- Não compartilhe sua chave de API com terceiros.
- A chave é pessoal e intransferível, devendo ser utilizada apenas em ambientes autorizados.
- Armazene sua chave em variáveis de ambiente (ex: arquivos
.env). - Nunca exponha a chave diretamente no código-fonte ou em repositórios públicos.
📚 Guia completo de autenticação
Para detalhes adicionais, exemplos práticos em diferentes linguagens e frameworks e melhores práticas de uso, consulte o nosso guia completo: