Autenticação
O acesso às APIs de integração é realizado por meio de API Key e API Secret.
Geração de credenciais
-
Acesse:
-
Access Management → API Keys
-
-
Gere uma nova chave
-
Armazene com segurança
Headers obrigatórios
Para executar requisições em cada rota será necessário informar no header a as Chaves de API geradas para integração:
x-api-key: {api_key}
x-api-secret: {api_secret}
Exemplo de requisição
curl -X GET "https://api-{tenant}.contractflow.tech/contractflow/integration/health-check" \
-H "x-api-key: {api_key}" \
-H "x-api-secret: {api_secret}"
Boas práticas
-
Não expor credenciais em código-fonte
-
Utilizar variáveis de ambiente
-
Implementar rotação periódica
-
Restringir acesso às chaves