Referência da API

Tratamento de Erros

Códigos de erro padrão, headers de rate-limit e troubleshooting.

Última atualização:

Tratamento de Erros

Todas as respostas de erro seguem um formato consistente com um código de erro e uma mensagem legível por humanos:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Description of what went wrong"
  }
}

Códigos de Erro

HTTP StatusCodeDescription
400VALIDATION_ERRORParâmetros de pedido inválidos ou em falta
401UNAUTHORIZEDChave de API em falta ou inválida
402PAYMENT_REQUIREDCréditos insuficientes
403FORBIDDENO acesso à API requer o plano Business, ou ação não permitida
403LIMIT_EXCEEDEDLimites do plano atingidos (projetos, builds, etc.)
404NOT_FOUNDRecurso não encontrado ou inacessível
409CONFLICTConflito de recursos (deployment em curso, domínio ocupado, etc.)
429RATE_LIMITEDDemasiados pedidos — verifica os cabeçalhos de limite de taxa
500INTERNAL_ERRORErro de servidor — tenta novamente ou contacta o suporte

Cabeçalhos de Limite de Taxa

Cada resposta inclui estes cabeçalhos:

  • X-RateLimit-Remaining — Número de pedidos restantes na janela atual
  • X-RateLimit-Reset — Segundos até a janela de limite de taxa ser reiniciada

Quando recebes uma resposta 429, aguarda o número de segundos indicado por X-RateLimit-Reset antes de tentar novamente.

Custos em Créditos

Ações da API que consomem créditos:

ActionCredits
Criar projeto (build inicial)5
Refinamento1
Edição de código1
Republicar1
Rollback1
Clone2
Reativar1
Pergunta ao Consultor1

Os administradores estão isentos de cobranças de créditos.

Resolução de Problemas

  • 401 Unauthorized — Verifica se a tua chave de API começa com flp_ e está incluída como Bearer token
  • 403 Forbidden — Confirma que a tua conta tem uma subscrição Business ativa
  • 409 Conflict no deploy — Aguarda a conclusão do deployment atual ou cancela-o primeiro
  • Erros de subdomínio — Os subdomínios devem ser em minúsculas, ter 3-63 caracteres e conter apenas letras, números e hífenes