Errors

• Códigos na faixa 2xx indicam sucesso
• Códigos na faixa 4xx indicam um erro causado pelas informações fornecidas
• Códigos na faixa 5xx indicam um erro nos nossos servidores (esses são raros)

​

Códigos de Status HTTP

​

Tipos de Erros e Exemplos

​

Erros de Autenticação (403)

{
"error": "Invalid authentication"
}

• Chave de API inválida
• Chave de API expirada
• Header de Authorization ausente
• Permissões insuficientes

​

Erros de Validação (400)

{
"error": "Validation failed",
"messages": {
"url": ["The url field must be a valid HTTPS URL"],
"method": ["The method must be one of: POST, GET"]
}
}

• Webhooks
  • A URL deve ser uma URL HTTPS válida
  • O método deve ser POST ou GET
  • O status deve ser “active” ou “inactive”
• Arquivos
  • O arquivo deve ser fornecido para upload
  • O flag de processamento é opcional (padrão: false)

​

Erros de Rate Limit (429)

{
"error": "Rate limit exceeded",
"retry_after": 60
}

​

Erros de Servidor (500)

{
"error": "Internal server error"
}

​

Header de workspace ausente (422)

{
  "message": "The x-workspace-id header is required."
}