Errores - The Companies API

The Companies API utiliza códigos de respuesta HTTP convencionales para indicar el éxito o fracaso de una solicitud de API.

Generalmente, los códigos en el rango 2xx indican éxito.

Los códigos en el rango 4xx indican un error que falló dada la información proporcionada (por ejemplo, se omitió un parámetro requerido).

Los códigos en el rango 5xx indican un error en nuestros servidores (estos son raros).

Algunos errores 4xx que pueden ser manejados de manera programada incluyen un código de error que explica brevemente lo que sucedió.

Regístrate para acceder a todas las características

Obtén tu token de API y comienza a implementar la API en tu producto con 500 créditos gratuitos.

No se requiere tarjeta de crédito

Objeto de error

error. codestring

Para algunos errores que podrían manejarse programáticamente, un número que indica el código de error reportado.

403

error. messagestring

Un mensaje que proporciona más detalles sobre el error.

Missing API token

error. typestring

El tipo de error devuelto (ver la lista a su derecha).

apiConnectionError

Valores posibles

apiConnectionError

apiError

authenticationError

invalidRequestError

noCreditsRemaining

rateLimitError

Resumen de códigos de estado HTTP

200 - OKLa solicitud fue exitosa.

400 - Solicitud IncorrectaLa solicitud fue inaceptable, a menudo debido a la falta de un parámetro requerido.

401 - No AutorizadoNo se proporcionó un token de API válido.

402 - Solicitud FallidaLos parámetros eran válidos, pero la solicitud falló.

403 - ProhibidoEl token de API no tiene permiso para realizar la solicitud.

404 - No EncontradoEl recurso solicitado no existe.

409 - ConflictoLa solicitud entra en conflicto con otra solicitud (quizás debido al uso de la misma clave idempotente).

429 - Demasiadas SolicitudesDemasiadas solicitudes golpearon la API muy rápidamente. Recomendamos un retroceso exponencial de sus solicitudes.

500, 502, 503, 504 - Errores del ServidorAlgo salió mal en nuestro lado. Estos errores raros deben ser reportados, pero los capturamos con PostHog y los arreglamos tan pronto como ocurren.

Resumen de tipos de errores HTTP

apiConnectionErrorFallo al conectar con la API de Companies.

apiErrorLos errores de API cubren cualquier otro tipo de problema (por ejemplo, un problema temporal con los servidores de la API de Companies) y son extremadamente poco comunes.

authenticationErrorFallo al autenticarse correctamente en la solicitud.

invalidRequestErrorLos errores de solicitud inválida surgen cuando su solicitud tiene parámetros inválidos.

noCreditsRemainingNo tiene créditos restantes para hacer esta solicitud.

rateLimitErrorDemasiadas solicitudes golpearon la API muy rápidamente. Recomendamos un retroceso exponencial de sus solicitudes.