Errores
La API de atoship usa los códigos de respuesta HTTP convencionales para indicar si una solicitud fue exitosa o falló. Los códigos del rango 2xx indican éxito, los 4xx indican errores del cliente y los 5xx indican errores del servidor.
Códigos de estado HTTP
Códigos de éxito
La solicitud se completó correctamente
El recurso se creó correctamente
Errores del cliente
Parámetros de la solicitud no válidos
Clave de API no válida o ausente
Saldo insuficiente o pago rechazado
La clave de API no tiene los permisos necesarios
El recurso no existe
Error de validación en los datos de la solicitud
Se superó el límite de velocidad
Errores del servidor
Algo salió mal de nuestro lado
La API no está disponible temporalmente
Objeto de error
Todos los errores devuelven un objeto JSON con la siguiente estructura:
typestringCategoría del error (p. ej., "invalid_request_error")
codestringCódigo de error legible por máquina
messagestringDescripción del error legible por humanos
paramstring (opcional)Parámetro que causó el error
request_idstringID único de la solicitud para depuración
Manejo de errores
Usa el código de estado para determinar la categoría del error
Lee el type y el code del error para manejarlo de forma programática
Muestra el message a los usuarios para darles información útil
Incluye el request_id cuando contactes con soporte
| 1 | { |
| 2 | "error": { |
| 3 | "type": "invalid_request_error", |
| 4 | "code": "invalid_parameter", |
| 5 | "message": "Invalid address: zip code is required", |
| 6 | "param": "to_address.zip", |
| 7 | "request_id": "req_abc123def456" |
| 8 | } |
| 9 | } |