Skip to main content
A API pública está disponível em /v1 na origem do seu painel Failproof AI.

​
Criar uma chave e fazer uma requisição

  1. Abra Administração → Chaves, selecione Criar chave e escolha o conjunto de permissões mais restrito que atenda à integração.
  2. Adicione concessões individuais apenas quando necessário, crie a chave e copie o segredo de uso único.
  3. Faça uma requisição de teste para /v1/sessions e confirme que a chave permanece ativa na página de Chaves.
  4. Rotacione ou desative a chave pelo menu de ações quando a integração mudar de responsável. O painel de criação de nova chave de API com presets de permissões e concessões individuais.
O painel de criação é exibido acima. O segredo de uso único aparece apenas após você selecionar criar; copie-o antes de fechar a confirmação.
As chaves têm escopo definido por organização e conjunto de permissões. Uma requisição sem a permissão necessária para o endpoint retorna 403 e identifica a permissão ausente.

​
Seleção de organização

Uma chave de organização age automaticamente sobre sua organização. Uma chave com escopo de instância pode selecionar uma organização por requisição:
Utilize o seletor de organização no cabeçalho do painel antes de abrir Administração → Chaves. As chaves criadas ali pertencem à organização selecionada. Confirme o slug da organização na URL e nos detalhes da chave antes de copiar a credencial para automação.
Utilize as páginas de endpoints geradas nesta seção para consultar rotas atuais, parâmetros, requisitos de permissão e códigos de status. A especificação é gerada a partir das anotações de rotas do servidor e verificada em relação ao roteador /v1. A especificação atual possui cobertura completa de rotas, métodos, parâmetros, permissões e códigos de status. Alguns corpos de resposta permanecem intencionalmente sem tipagem, pois o servidor ainda os constrói como JSON dinâmico. Inspecione uma resposta real antes de gerar um cliente fortemente tipado para um endpoint sem esquema de resposta. Utilize Content-Type: application/json para escritas JSON. Trate 401 como autenticação ausente ou inválida, 403 como identidade válida sem a permissão necessária, 404 como recurso inexistente ou inacessível pela organização, 409 como conflito de estado e 422 como valor de campo ou permissão inválido. As respostas de erro incluem uma mensagem legível; falhas de permissão também indicam a concessão necessária.
A implantação de aplicação de políticas é gerenciada intencionalmente fora da superfície pública /v1 padrão. Utilize o fluxo de implantação Cloud suportado.