Documentação do app v1.0

Quickstart — entre no painel e cadastre a primeira chave

Você entra no painel pela Conta Nommand, cadastra a primeira chave de provedor, cria um grupo com estratégia, expõe uma Config de URL e emite a chave sk-lb- que atende o primeiro pedido — tudo em cinco telas.

Pré-requisitos#

Este caminho usa as telas de administração. Antes de começar, confirme o que você tem em mãos:

  • Uma Conta Nommand ativa, com vínculo numa empresa e papel ADMIN ou OWNER. As telas deste quickstart — Chaves de API, Grupos de chaves, Chaves de URL — são visíveis e editáveis só a partir de ADMIN.
  • Uma chave de provedor upstream para cadastrar: o valor cru que o provedor emitiu (sk-ant-… da Anthropic, sk-or-… do OpenRouter, e assim por diante, conforme o provedor).
  • O endereço do painel da sua instalação (a SPA responde na porta 3016; o backend Fastify, na 3018).
  • Não há senha nem ADMIN_API_KEY

    O login é exclusivamente por SSO contra a Conta Nommand. Não existe senha local, não existe cadastro direto no Load Balance e não existe ADMIN_API_KEY: a credencial foi removida do código, e a sessão do painel vive num cookie assinado — nunca num header Authorization.

    Configure o painel em cinco passos#

    Cada passo abaixo é uma ação de tela. O painel conversa com o backend por HTTP na sessão do cookie; os blocos de código mostram, como ilustração, o corpo que a tela envia por baixo.

    1. Entre no painel pela Conta Nommand

      Abra o endereço do painel. Sem sessão, qualquer rota protegida leva ao cartão Entrar, com o botão Entrar com a Conta Nommand. Clique nele: você sai do Load Balance, autentica na Conta Nommand e volta com a empresa ativa e o seu papel. A sessão dura 7 dias e expira junto com o contrato da empresa na Conta.

      Depois do login você cai na Visão geral (/app/overview). A navegação da sidebar tem três seções: Monitoramento, Configuração e Nomad. Os passos seguintes moram em Configuração.

    2. Cadastre a primeira chave de provedor

      Na sidebar, abra Chaves de API (/app/keys). Clique no botão Adicionar chave no topo da lista: abre o dialog Adicionar chave de API. Preencha:

    3. Nome de exibição — como a chave aparece na lista, por exemplo Claude em produção.
    4. Chave de API — o valor cru do provedor, colado inteiro (placeholder sk-…).
    5. Provedor — o cartão do provedor no menu (Anthropic, Z.AI, OpenAI, OpenRouter, e os demais); escolher preenche a URL base automaticamente.
    6. URL base — o endpoint do provedor, preenchido pelo painel e editável quando o provedor tem mais de um plano.
    7. Confirme com Criar chave no rodapé do dialog. A chave aparece na lista — em cartões ou tabela — e o Load Balance passa a dona de guardá-la: o valor é cifrado em repouso e nunca volta a ser exibido.

    8. Crie um grupo e escolha a estratégia

      Uma chave sozinha já serve tráfego pelo pool padrão, mas o roteamento com estratégia mora nos grupos. Na sidebar, abra Grupos de chaves (/app/groups) e clique em Novo grupo. No formulário Novo grupo de chaves: preencha Name (por exemplo Claude em produção), deixe a Descrição opcional, e role até Estratégia de balanceamento.

      A seção Estratégia de balanceamento é um seletor de cartões com cinco opções. O que cada uma faz:

      EstratégiaO que faz
      Rodízio (round_robin)Distribui os pedidos entre todas as chaves saudáveis do grupo — a opção padrão.
      Prioridade (priority)Roteia sempre para a primeira chave saudável da lista; se ela falhar, cai para a próxima e volta sozinha quando a primeira recuperar.
      Avaliada (rated)Escolhe a chave mais rápida pelo histórico real de tempo até o primeiro token e taxa de erro.
      Com reserva (hedge)Tudo da Avaliada, mais uma segunda chamada se a escolhida não der o primeiro token em 2 segundos.
      Corrida (race)Dispara 2 a 4 chaves ao mesmo tempo e fica com a resposta mais rápida.

      Em Chaves, no bloco Adicionar chaves, busque a chave criada no passo anterior e clique nela para incluí-la no grupo. No modo Prioridade, arraste as chaves para ordenar a cascata. Confirme com Criar grupo no topo.

    9. Crie a Config de URL que o proxy vai atender

      O cliente não chama chaves: chama uma URL. Na sidebar, abra Configs de URL (/app/configs) e clique em New Config. No dialog Nova configuração de URL, preencha:

    10. Name — o nome da configuração (por exemplo Produção).
    11. URL personalizada — o segmento da URL pública, por exemplo ana; o cliente vai chamar /{orgSlug}/ana/v1/messages.
    12. Modo de roteamento — em Roteamento de chaves, troque Padrão (rodízio) por Grupo específico de chaves e selecione o grupo criado no passo anterior.
    13. Ativa — deixe ligada; configurações desativadas são ignoradas pelo proxy.
    14. Confirme com Salvar. A nova config aparece na lista com a URL completa montada, pronta para copiar — o host público vem do painel, não do endereço do browser.

    15. Emita a chave de serviço <code>sk-lb-</code>

      Toda URL exige uma chave do Load Balance. Na sidebar, abra Chaves de URL (/app/client-keys), na aba Chaves de serviço. Preencha o formulário:

    16. Nome — para quem a chave é (exemplo: CI do repositório X).
    17. URLs liberadas — a Config de URL criada no passo anterior; a chave vale só nas URLs marcadas aqui.
    18. Validade — Sem prazo, 30 dias, 90 dias ou 1 ano.
    19. Clique em Criar. O banner Copie a chave de serviço agora mostra o valor sk-lb-… e um botão de copiar — é a única vez: o servidor guarda só o hash, e depois disso a lista mostra apenas o prefixo. Guarde o valor num gerenciador de senhas ou direto na configuração do cliente.

      Como ilustração, o formulário envia um corpo assim ao backend (POST /api/organizations/:id/service-keys):

      json
      {
        "name": "CI do repositório X",
        "configIds": ["cfg-9f2b…"],
        "expiresInDays": null
      }
      json
      {
        "key": {
          "id": "cak-77d1…",
          "name": "CI do repositório X",
          "prefix": "kQ3xwL2m",
          "configs": [{ "id": "cfg-9f2b…", "name": "Produção" }]
        },
        "secret": "sk-lb-…"
      }

      A resposta traz o key persistido (com o prefix que a lista exibe) e o secret cru, que só existe nesta resposta.

    A partir daqui o caminho continua no cliente: aponte o ANTHROPIC_BASE_URL para a URL da Config e o ANTHROPIC_API_KEY para a chave sk-lb- emitida no passo 5. O Quickstart — aponte seu cliente para o Load Balance mostra o comando pronto; o primeiro pedido que passar por ela já aparece em Visão geral e em Logs de requisições.

    Próximos passos#

    Com a chave cadastrada, o grupo com estratégia e a URL exposta, o próximo passo é entender o produto por inteiro — o que cada tela administra e como as peças se encaixam.

    Depois de dominar o básico, explore além:

    Documentação gerada com a skill docs-padrao.