Solución de problemas de la API de exportación de datos
Utilice este tema para interpretar las respuestas de error más habituales de la API
de exportación de datos e identificar la causa más probable y la solución para cada
una de ellas. Cada respuesta de error incluye un
code, un message y un statusCode numérico; el valor code identifica la condición concreta.Errores de autenticación y autorización
| Código de error | Causa probable | Qué probar |
|---|---|---|
ERR_INVALID_APIKEY (401) |
Falta la cabecera «x-api-key», está mal formada, ha caducado o se ha eliminado. También se produce brevemente (normalmente
menos de un minuto) inmediatamente después de que se cree o se rote una clave, antes
de que se registre la nueva clave. |
Compruebe que la solicitud incluya la cabecera x-api-key con el valor completo de la clave API. En Account Administration, compruebe que la clave sigue existiendo y que no ha caducado. Si la clave se acaba
de crear o se acaba de rotar, espere un minuto y vuelva a intentarlo. |
ERR_UNAUTHORIZED_PRINTERS (403) |
La solicitud incluye uno o varios valores de printerId a los que la clave API no tiene acceso. |
Llame a /printers con la misma clave API para ver exactamente qué impresoras están disponibles y, a
continuación, vuelva a enviar la solicitud indicando únicamente los identificadores
de esas impresoras. |
ERR_TENANT_NOT_FOUND (404) |
La clave API se reconoce, pero no está asociada a ninguna cuenta activa. Esto puede ocurrir si se ha eliminado una cuenta o si está mal configurada. | Póngase en contacto con su representante de cuenta de Ricoh para confirmar que su tenant está activo y que la clave API está asociada a él. |
Errores de validación de parámetros (400 Solicitud incorrecta)
Cada error de validación de parámetros devuelve un código de estado 400. El valor
code identifica el problema concreto.
| Código de error | Causa probable | Qué probar |
|---|---|---|
ERR_MISSING_PRINTER_ID |
La solicitud no incluía ningún valor de printerId. Se requiere al menos uno para /jobs, /printer-states y /printer-interventions. |
Añada al menos un parámetro de consulta printerId. Repita el parámetro para incluir varias impresoras. |
ERR_INVALID_PRINTER_ID_FORMAT |
El valor printerId no es un UUID válido. |
Compruebe el valor comparándolo con la respuesta obtenida en /printers. Entre los errores más comunes se encuentran los espacios en blanco de más, los caracteres
que faltan o pegar el nombre de la impresora en lugar del identificador de la misma. |
ERR_INVALID_TIMEZONE |
Falta el valor de timezone o no es un identificador válido de zona horaria de la IANA. |
Utilice un identificador basado en la región, como America/Denver o Europe/Bucharest. No se aceptan abreviaturas de tres letras, como MST o EST. En la página de documentación interactiva se muestra una lista de todos los valores
admitidos. |
ERR_INVALID_DATE_FORMAT |
El valor de startDateTime» o endDateTime no coincide con el formato esperado. |
Utilice el formato YYYY-MM-DDTHH:MM:SS, opcionalmente con el sufijo .sss para indicar los milisegundos. No incluya un desplazamiento respecto al UTC ni el
sufijo Z; la zona horaria se indica por separado en el parámetro timezone. |
ERR_INVALID_DATE_RANGE |
startDateTime es igual o posterior a endDateTime. |
Compruebe que startDateTime sea anterior a endDateTime en la zona horaria indicada. |
ERR_DATE_RANGE_EXCEEDED |
El intervalo de tiempo entre startDateTime y endDateTime supera el rango máximo permitido. |
Reduzca la duración del intervalo de tiempo solicitado. Consulte Cómo gestionar los límites de respuesta de la API de exportación de datos para obtener orientación sobre la división en fragmentos. |
ERR_INVALID_JOB_STATE |
El valor de jobState no se encuentra entre los valores admitidos. |
Utilice una de las siguientes opciones: printing, printed, aborted o completed. Tenga en cuenta que el término completed incluye tanto los trabajos printed como aborted. |
ERR_INVALID_STATE_CATEGORY |
El valor de stateCategory no es uno de los valores admitidos. |
Utilice una de las opciones: up», down o idle. |
ERR_INVALID_LANGUAGE |
El valor language proporcionado a /printer-interventions no es uno de los valores aceptados. |
Seleccione una de las siguientes opciones: en, de, ja, it, fr o es. Este error significa que el propio código ha sido rechazado; un código que se acepta
pero que carece de traducción para una descripción concreta no da lugar a un error,
ya que la API devuelve dicha descripción en inglés en su lugar. |
ERR_INVALID_BOOLEAN_PARAM |
El parámetro currentState o stateCategoryOnly tiene un valor distinto de true o false. |
Utilice las cadenas literales en minúsculas true o false. |
ERR_UNKNOWN_PARAMETERS |
La solicitud incluye uno o varios parámetros que el punto final no acepta. | Compare la solicitud con la lista de parámetros para el punto final en la documentación interactiva. Entre las causas más habituales se encuentran los errores tipográficos, los parámetros destinados a un punto final distinto o los parámetros de seguimiento adicionales añadidos por un cliente HTTP. |
ERR_DUPLICATE_PARAMETERS |
Se ha proporcionado el mismo parámetro más de una vez y el punto final no admite duplicados de dicho parámetro. | Compruebe la lista de parámetros. El parámetro printerId puede repetirse (una vez por impresora); los demás parámetros deben aparecer como
máximo una vez. |
ERR_EMPTY_PARAMETERS |
Se ha introducido un parámetro obligatorio, pero carece de valor. | Compruebe que todos los parámetros obligatorios tengan un valor distinto de vacío. |
ERR_INVALID_TENANT_ID |
El identificador de inquilino asociado a la clave API no es válido. | Póngase en contacto con su representante comercial de Ricoh. |
Errores relacionados con el tamaño de la respuesta y el método
| Código de error | Causa probable | Qué probar |
|---|---|---|
ERR_RESPONSE_LIMIT_EXCEEDED (413) |
Los datos coincidentes con la solicitud superarían el tamaño máximo de la respuesta.
El cuerpo de la respuesta incluye un campo maxJobs que indica el límite vigente. |
Reduzca el intervalo de fechas, solicite menos impresoras o haga ambas cosas, y vuelva a enviar la solicitud. Consulte Cómo gestionar los límites de respuesta de la API de exportación de datos para conocer los patrones de agrupación recomendados. |
ERR_UNSUPPORTED_METHOD (405) |
La solicitud utilizó un método HTTP distinto de GET. |
La API de exportación de datos solo admite el método GET. Actualice su cliente para que utilice GET. |
Errores del servidor (500: Error interno del servidor)
Las 500 respuestas indican que se ha producido una condición inesperada en el servidor.
Los reintentos son seguros porque todos los puntos finales de la API de exportación
de datos son de tipo GET y no producen efectos secundarios. Espere unos segundos antes de volver a intentarlo
y utilice el retroceso exponencial si el error persiste.
| Código de error | Causa probable | Qué probar |
|---|---|---|
ERR_INTERNAL_SERVER_ERROR |
Se ha producido una condición inesperada en el servidor. | Espere unos segundos y vuelva a intentarlo. Si el error persiste durante más de unos minutos, póngase en contacto con su representante comercial de Ricoh |
ERR_TENANT_CHECK_FAILED |
El servidor no ha podido verificar el inquilino asociado a la clave API. | Espere unos segundos y vuelva a intentarlo. Si el error persiste, póngase en contacto con su representante comercial de Ricoh. |
ERR_PRINTERS_FETCH_FAILED |
El servidor no ha podido recuperar la lista de impresoras del inquilino. | Espere unos segundos y vuelva a intentarlo. Si el error persiste, póngase en contacto con su representante comercial de Ricoh. |
ERR_PRINTER_STATES_FETCH_FAILED |
El servidor no ha podido obtener los datos sobre el estado de la impresora correspondientes a la solicitud. | Espere unos segundos y vuelva a intentarlo. Si el error persiste, póngase en contacto con su representante comercial de Ricoh. |
Otros síntomas
- La respuesta está vacía (
[]) pero usted espera datos - Un array vacío significa que no hay coincidencias con la solicitud. Compruebe el intervalo
de tiempo (la API solo proporciona datos de los últimos siete días), la zona horaria,
los valores
printerIdy cualquier filtro, comojobStateostateCategory. - Los valores de fecha y hora de la respuesta no coinciden con lo que esperaba
- Las marcas de tiempo de las respuestas corresponden a la hora local en la zona horaria
indicada en la solicitud. Al enviar la misma solicitud con un valor
timezonediferente, se obtienen cadenas de marca de tiempo distintas, aunque describan los mismos eventos. Consulte Manejo de fechas y horas en la API de exportación de datos. - Falta una impresora en la respuesta de
/printers - La API solo devuelve las impresoras que están supervisadas por un recopilador de datos. Si falta una impresora, compruebe que esté registrada en un recopilador de datos y que tenga actualmente una conexión.
- La respuesta sobre el estado de una impresora incluye categorías
unknown - Una categoría
unknownindica que no se ha podido clasificar el estado sin procesar de la impresora. Consulte Estados de la impresora y categorías de estados para ver la correspondencia completa entre estados y categorías.