logo
ReferenciaErros Comuns
Referencia

Erros Comuns

Diagnóstico e resolução dos erros mais frequentes ao integrar com a Keyspot Partner API.

Formato de erro

Todas as respostas de erro seguem o mesmo formato:

{
  "error": "Mensagem de erro legível",
  "code": "CODIGO_PROGRAMATICO"
}

Use o campo code para identificar o erro programaticamente e o campo error para exibir mensagens ao desenvolvedor.

Erros por código HTTP

Causa: parâmetros inválidos ou ausentes na requisição.

VALIDATION_ERROR

Campos obrigatórios ausentes ou com formato inválido.

{ "error": "fields: The "fields" parameter is required", "code": "VALIDATION_ERROR" }

Solução: verifique se todos os campos obrigatórios estão presentes e com os tipos corretos. Para POST /v1/leads, os campos name, email, phone e message são obrigatórios.

INVALID_FIELDS

Campos solicitados no parâmetro fields não existem na entidade.

{ "error": "Invalid fields: foo, bar", "code": "INVALID_FIELDS" }

Solução: consulte GET /v1/fields para ver os campos disponíveis. Use os nomes exatos sem sub-campos (ex: address, não address.street).

INVALID_ENTITY

Entidade passada no endpoint /v1/values não existe.

{ "error": "Invalid entity: foo. Use one of: properties, leads", "code": "INVALID_ENTITY" }

Solução: use properties ou leads como entidade.

INVALID_FIELD

Campo passado no endpoint /v1/values não é consultável.

{ "error": "Field "title" is not queryable for "properties". Queryable fields: status, operationType, propertyType, highlight", "code": "INVALID_FIELD" }

Solução: consulte a lista de campos consultáveis no Dicionário de Dados.

MISSING_BODY

Requisição POST sem body.

{ "error": "Request body is required", "code": "MISSING_BODY" }

Solução: envie um body JSON válido com o header Content-Type: application/json.

Próximos passos