Pular para o conteúdo principal

API e automação

Tudo o que o console faz, ele faz pela mesma API que está disponível para você. Não existe caminho privilegiado: a interface é um cliente da API, como qualquer outro.

Superfície única​

Esse princípio tem uma consequência prática forte: se uma capacidade não está na API, nada a alcança — nem a interface, nem um script, nem um agente. Isso elimina a classe inteira de problemas em que uma automação consegue fazer mais do que a interface permitiria.

Nenhum cliente recebe credencial administrativa de infraestrutura, acesso ao banco de controle ou caminho alternativo de mutação.

Como a API se comporta​

RegraO que significa para quem integra
Escopo pelo autenticadoA organização vem da sua sessão, nunca do corpo da requisição
Operação longa é assíncronaPublicar responde com um identificador de operação; você acompanha o progresso
Criação é protegida contra repetiçãoReenviar a mesma requisição com a mesma chave devolve a mesma resposta, não um segundo recurso
Erro tem formato únicoCódigo estável, mensagem em português e ação sugerida
Estado tem dois vocabuláriosO estado preciso e o estado que o usuário lê vêm juntos, para nenhum cliente reimplementar o mapeamento

Acompanhar uma operação​

Publicar, restaurar, ajustar recursos e trocar o endereço de um projeto já publicado criam uma operação. Ela tem estado próprio, progresso consultável e pode ser cancelada enquanto a janela de cancelamento existir.

É por isso que a interface nunca fica com um cronômetro parado: ela está acompanhando a operação, e mostra o que aconteceu até agora.

Operação assistida por agentes​

O Zero nasceu para ser operado também por agentes — o Imaginne, por exemplo. A regra que torna isso seguro cabe em uma frase:

Toda operação de um agente passa pela mesma API governada, com as mesmas permissões da pessoa que o acionou.

Um agente pode analisar um repositório, explicar o que será publicado, publicar, observar, diagnosticar, propor correção e reverter. O que ele não pode é escapar da API: não há superfície paralela.

Duas garantias adicionais:

  • Ação destrutiva disparada por agente exige confirmação humana.
  • A auditoria separa autor humano de autor agente, e a origem da ação (interface, script, integração) é registrada à parte.

Credenciais e acesso​

O acesso à API usa a mesma identidade do console. Chaves de longa duração para integração são concedidas pela equipe que administra a plataforma — não há autoatendimento para isso hoje.

Disponibilidade​

Nem todo recurso descrito no contrato está exposto nesta instalação. A lista do que existe hoje está em O que já existe, e o console responde por capacidade em vez de deixar uma tela dizer "não encontrado" quando a capacidade é que não existe.

Para obter o contrato da API na versão da sua instalação, fale com a equipe que administra a plataforma.

Próximos passos​