Chaves API

As chaves de API concedem acesso programático às contas da sua Organização a sistemas automatizados, bots de trading, scripts operacionais, pipelines de relatórios e sessões de trading FIX. Este artigo aborda o modelo de permissões das chaves de API, como as chaves se associam a contas, como a Governança da Organização se aplica às operações iniciadas por chaves e como a própria administração de chaves é governada.

As chaves de API não são Membros com credenciais. Elas têm seu próprio modelo de permissões, mais simples:

Membro

Chave API

Autenticação

Acesso individual com 2FA

Credenciais de chave de API

Acesso à interface

Sim

Não, somente via API

Modelo de permissões

Perfil de Workflow + Funções de Conta

Permissões de chave de API aplicadas às contas selecionadas

Variação por conta

Sim, as funções podem conceder permissões diferentes em contas diferentes

Não, as permissões da chave se aplicam igualmente a todas as contas selecionadas

Pode iniciar solicitações de saque e transferência

Sim, quando permitido

Sim, quando permitido

Pode aprovar solicitações

Sim, exceto as próprias

Nunca

Fluxos de trabalho administrativos

Sim, conforme o Perfil de Workflow

Nunca

Os dois modelos são deliberadamente separados. Os Membros recebem funções, perfis e granularidade por conta porque pessoas acumulam responsabilidades variadas. As Chaves seguem um modelo simples de escopo e contas porque automações precisam ser restritas, uniformes e fáceis de auditar.

Uma chave de API combina duas seleções: o que ela pode fazer (suas permissões) e onde (suas contas).

Permissões

Grupo

Permissão

O que permite

Fundos

Consultar fundos

Visualizar saldos e status de depósito

Depositar

Gerar endereços de depósito e visualizar histórico de depósitos

Retirar

Iniciar solicitações de saque (consulte «Governança e chaves de API»)

Ganhe

Alocar e desalocar produtos Earn

Ordens

Consultar ordens em aberto

Visualizar ordens em aberto e negociações ativas

Consultar ordens fechadas

Visualizar histórico de ordens e negociações concluídas

Criar e modificar ordens

Enviar e modificar ordens

Cancelar e fechar ordens

Cancelar ordens em aberto e fechar posições

Endereços

Adicione o endereço de retirada

Iniciar solicitações para adicionar endereços à lista de permissões

Atualizar endereço de retirada

Iniciar solicitações para alterar endereços da lista de permissões

Dados

Consultar ledger

Visualizar histórico de transações e do ledger

Exportar dados

Exportar dados da conta para relatórios e reconciliação

Mapeamento de contas

Cada chave é mapeada para uma ou mais contas, definidas na criação e editáveis posteriormente. As permissões da chave se aplicam de forma uniforme a todas as contas selecionadas:

  • Uma chave com as permissões Consultar fundos e Criar e modificar ordens em duas contas selecionadas pode ler saldos e negociar em ambas, sem acessar nada além disso.
  • Não há variação por conta dentro de uma chave. Se a sua automação precisar negociar em uma conta e apenas ler outra, use duas chaves. Isso mantém o raio de impacto de cada chave bem delimitado.

Conectividade FIX

Chaves com permissões de ordens oferecem suporte à conectividade FIX para negociação spot, junto às APIs REST e WebSocket. Uma sessão FIX carrega as mesmas permissões e o mesmo mapeamento de contas da chave associada: ela negocia apenas nas contas selecionadas da chave, dentro das permissões dela. Empresas que operam fluxo de ordens via FIX geralmente dedicam uma chave por sessão, com escopo nas contas operadas pela mesa.

Observação:

A negociação via WebSocket em contas que não sejam a conta principal ainda não está disponível para chaves de API; por ora, permanece como uma funcionalidade exclusiva do Proprietário. Fluxos de ordens automatizados em contas adicionais devem usar REST ou FIX. Consulte Disponibilidade e limitações.

Configurações de segurança

Configuração

Description

Validade da chave

Data opcional após a qual a chave deixa de funcionar

Data de início/fim de consulta

Restringe as consultas de dados a um intervalo de datas

Conexões WebSocket

Ativar ou desativar streaming em tempo real

Janela nonce personalizada

Ajuste de proteção contra replay para uso de alta frequência

Restrições de IP

Restringe o uso da chave a endereços IP ou intervalos CIDR específicos

Dica:

Conceda a cada chave as permissões mínimas, o menor número de contas e as restrições de IP mais rígidas que permitam cumprir sua função. Use chaves separadas por sistema: uma para o bot de trading, outra para relatórios. Assim, a revogação fica cirúrgica.

A Governança da Organização se aplica tanto ao que as chaves fazem quanto à forma como são gerenciadas.

O que as chaves fazem

A regra de duas categorias para Membros se aplica às chaves da mesma forma:

  • Operações diretas são executadas imediatamente. Negociação, Earn, consultas de saldo, consultas de ledger e exportações de dados são concluídas imediatamente, dentro das permissões e contas da chave.
  • Operações governadas criam solicitações. Um saque ou alteração de endereço iniciado por uma chave entra no mesmo fluxo que um iniciado por um Membro: a política do workflow decide se a operação é concluída imediatamente ou aguarda na fila de aprovação para revisão humana.

Uma chave só pode iniciar solicitações governadas. Chaves nunca têm a permissão Aprovar — a segregação de funções exige um Membro humano para cada aprovação, e um script não pode substituir esse julgamento. Quando a política de Solicitação de Saque exige duas aprovações, um saque iniciado por chave aguarda dois Membros, exatamente como um iniciado por Membro aguardaria.

Construa a automação em torno dessa assincronicidade: uma chamada de API bem-sucedida indica que a solicitação foi criada, não que os fundos foram movimentados. Acompanhe a solicitação até a conclusão e leve em conta a limitação atual: uma solicitação pendente não reserva fundos — se o saldo mudar durante a revisão, a solicitação aprovada falhará e precisará ser reenviada. Consulte Mantenha os fundos disponíveis até a aprovação.

As chaves também não têm acesso aos workflows administrativos. Gerenciar o acesso da equipe, chaves de API, contas, endereços (além de iniciar solicitações de endereço) e políticas é exclusivo de Membros.

Como as chaves são gerenciadas

Criar, editar e revogar chaves de API é uma operação governada pelo workflow dedicado Gerenciar Chaves de API, separado do Gerenciar Equipe e Acesso. Essa separação é importante por dois motivos:

  • Administradores diferentes. Você pode permitir que um engenheiro de operações gerencie chaves sem qualquer acesso para alterar as permissões dos Membros, e vice-versa.
  • Políticas diferentes. O gerenciamento de chaves pode ter seus próprios requisitos de aprovação. Muitas Organizações exigem aprovação independente para criar ou modificar uma chave — uma nova credencial é uma nova forma de acessar suas contas — e mantêm a revogação ágil.
  1. Acesse Chaves de API e selecione Criar chave.
  2. Dê à chave um nome que reflita sua finalidade – o sistema que ela atende e o que ela faz – para que sua função seja clara em auditorias e eventos de segurança.
  3. Selecione as permissões da chave.
  4. Selecione as contas nas quais a chave vai operar. As permissões se aplicam a todas elas de forma uniforme.
  5. Configure as definições de Security: expiração, restrições de IP e nonce window.
  6. Revise e confirme. Se a política Gerenciar Chaves de API exigir aprovação, a solicitação ficará aguardando as aprovações necessárias antes de a chave ser emitida.
Atenção:

Editar permissões ou contas de uma chave e revogar uma chave seguem o mesmo fluxo de governança.

Solução de problemas

A chamada criou uma solicitação de saque, e a política de Solicitação de Saque está aguardando aprovação. Verifique a página de Solicitações – a solicitação aparece lá com a chave como iniciadora, aguardando as aprovações necessárias dos Membros. É o modelo de governança funcionando como esperado: a automação propõe, as pessoas aprovam.

Se a solicitação foi aprovada e os fundos ainda não foram movimentados, verifique se o saldo de origem cobria o valor no momento da conclusão – uma solicitação pendente não reserva fundos, e atividades ocorridas durante a revisão podem fazer uma solicitação aprovada falhar. Reenvie quando o saldo estiver disponível novamente.

A conta com falha não está no mapeamento de contas da chave. Uma chave opera apenas nas contas selecionadas. Edite a chave para adicionar a conta, lembrando que o conjunto completo de permissões da chave será aplicado nela, já que chaves não permitem variação por conta. Se isso for muito amplo, crie uma segunda chave com escopo restrito à nova conta.

Uma única chave não pode ter permissões diferentes por conta. Crie duas chaves: uma chave de negociação vinculada à conta A e uma chave somente leitura vinculada à conta B. Chaves com escopo mais restrito também são mais fáceis de auditar e mais seguras de revogar.

O fluxo de trabalho Gerenciar Chaves de API provavelmente exige aprovação, e a solicitação ainda está pendente. A chave é emitida e seu segredo exibido somente após as aprovações necessárias serem coletadas. Verifique o status da solicitação na página Solicitações.

Não. A aprovação sempre exige um Membro humano. Esta é uma regra do sistema, não uma política configurável: é o que torna a aprovação multipartes relevante quando a automação inicia movimentações de fundos.

Precisa de mais ajuda?