Pestaña Claves de API

La pestaña Claves de API solo está disponible si su cuenta cuenta con una suscripción a RICOH Predictive Insight. Para ver la pestaña y utilizar las teclas, debe disponer de acceso d Administrador e a Account Administration.

Los dos enlaces situados en la parte superior de la pestaña permiten acceder a la información de referencia sobre la API de exportación de datos:

Primeros pasos con las claves API

Abre la ayuda de la API de exportación de datos, donde podrá consultar los pasos que debe seguir para empezar a utilizar las claves API, así como los puntos finales disponibles, los campos que devuelve cada uno de ellos y los límites que se aplican a las solicitudes.

Abrir el Explorador de API

Abre la página de documentación interactiva de la API, donde podrá consultar cada punto final, ver los parámetros que admite y enviar solicitudes de ejemplo directamente desde su navegador. Necesita el valor de una clave API para enviar una solicitud desde esa página.

Estas son las acciones que puede realizar en esta pestaña:

• Consulte todas las claves definidas para su cuenta y sus propiedades, tales como: Nombre, Estado y Fecha de caducidad.

  La tabla no muestra el valor de una clave.

• Cree una clave.

  Pulse Crear clave de API. Las claves suelen estar activas en un plazo de 30 segundos, aunque pueden producirse retrasos.

• Supervise las solicitudes de API de la cuenta en relación con los límites de la suscripción.

  El recuadro situado encima de la tabla de claves API muestra el plan de uso de la cuenta y el número máximo de llamadas a la API permitidas durante un periodo de 30 días. Realice un seguimiento del número de llamadas realizadas en los últimos 30 días.

• Modifique el nombre, la descripción o la fecha de caducidad de una clave existente.

  Haga clic con el botón derecho en una fila y seleccione Editar clave API. La modificación de una clave no altera su valor, por lo que las aplicaciones que ya la utilizan seguirán funcionando.

• Gire una clave para sustituir su valor.

  Haga clic con el botón derecho en una fila y seleccione Girar clave API. Establezca un periodo de solapamiento de modo que tanto el valor actual como el nuevo estén vigentes durante varios días, lo que le dará tiempo para actualizar sus aplicaciones. La clave con el nuevo valor suele estar disponible para su uso en un plazo de 30 segundos, aunque pueden producirse retrasos.

• Eliminar una clave.

  Haga clic con el botón derecho en una fila y seleccione Suprimir inmediatamente.

  Nota:
  • Al eliminar una clave, esta se elimina del sistema en el plazo de un minuto, aunque pueden producirse retrasos. Las claves eliminadas se eliminan de forma definitiva. Si intenta realizar una solicitud a la API utilizando una clave API después de haberla eliminado, la solicitud fallará.
  • Al eliminar una clave, se eliminan todas sus versiones. Si rota una clave y, a continuación, la elimina, se eliminarán ambas versiones de la clave, incluso si el periodo de solapamiento sigue activo.

Las claves no están limitadas a impresoras concretas. Cualquier persona que disponga del valor de una clave puede enviar solicitudes en nombre de su cuenta. Comparta las claves únicamente con las personas que se encargan de desarrollar las integraciones y cámbielas periódicamente de acuerdo con sus prácticas de seguridad.

Al hacer clic en , el icono de herramientas, se abre un menú desde el que puede actualizar la información de la tabla y gestionar las columnas de esta.