Creación y gestión de claves API

Una clave API autoriza las solicitudes a la API de exportación de datos. Las claves API se crean y gestionan en Account Administration, y debe introducir la clave al enviar solicitudes desde la página «Explorador de API» o desde sus propias aplicaciones.

Cada solicitud enviada a la API de exportación de datos debe incluir una clave API válida en la cabecera de solicitud x-api-key. La clave autentica la solicitud dirigida a su cuenta (inquilino).

Para crear claves API, debe disponer deAdministradoracceso de tipo aAccount Administration.

Siga los procedimientos que se describen en este apartado para:

  • Cree una nueva clave API.
  • Modifique el nombre, la fecha de caducidad o la descripción de una clave existente.
  • Rote una clave para sustituir su valor secreto sin modificar la identidad de la misma.
  • Elimine una clave del sistema.
Nota: Cuando se crea o se renueva una clave API, hay un breve intervalo de tiempo antes de que la clave quede registrada y esté lista para su uso. Por lo general, este intervalo es inferior a un minuto.
  • Para crear una nueva clave API:
    1. En el panel izquierdo deAccount Administration, haga clic en Claves de API.
    2. Pulse Crear clave de API.
    3. Introduzca un nombre y una descripción para esta clave.
    4. Para Fecha de caducidad, elija una fecha con una antelación máxima de 367 días.
    5. En Licencias , seleccione el plan de uso «RPI Data Export» para las claves API.
    6. Pulse Siguiente.
      La clave se ha generado y guardado.
    7. Haga clic en Copiar para copiar la clave generada en el portapapeles. Guárdelo en un lugar seguro.
      Importante: El valor completo de la clave solo se muestra cuando se crea la clave. No podrá volver a acceder a él. Si pierde el valor, deberá rotar la clave para generar una nueva.
    1. Haga clic en « He guardado mi llave » para cerrar el cuadro de diálogo.
  • Para editar una clave API existente:
    1. En el panel izquierdo deAccount Administration, haga clic en Claves de API.
    2. Busque la clave que desee modificar. Haga clic con el botón derecho del ratón en la fila correspondiente a la clave y seleccione « Editar clave API ».
    3. Actualice el nombre, la fecha de caducidad o la descripción según sea necesario.
      Al editar una clave, el valor de la misma no se modifica. Las aplicaciones que ya utilizan la clave seguirán funcionando sin cambios.
    4. Pulse Aceptar.
  • Para rotar una clave API:
    1. En el panel izquierdo deAccount Administration, haga clic en Claves de API.
    2. Localice la clave que desea rotar. Haga clic con el botón derecho del ratón en la fila correspondiente a la clave y seleccione « Girar clave API ».
    3. Establezca el valor de « Periodo de solapamiento en días » en el número de días durante los que desea que tanto la clave actual como la versión rotada estén activas al mismo tiempo.
    4. Establezca un nuevo valor de « Fecha de caducidad » para la clave.
    5. Pulse Aceptar.
    6. Haga clic en Copiar para copiar la clave generada en el portapapeles. Guárdelo en un lugar seguro.
      Importante: El valor completo de la clave solo se muestra cuando se crea la clave. No podrá volver a acceder a él. Si pierde el valor, deberá rotar la clave para generar una nueva.
    7. Actualice cualquier aplicación, script o sesión de documentación interactiva guardada que utilice la clave antes de que finalice el periodo de solapamiento.
  • Para eliminar una clave del sistema:
    1. En el panel izquierdo deAccount Administration, haga clic en Claves de API.
    2. Localice la clave que desea rotar. Haga clic con el botón derecho del ratón en la fila correspondiente a la clave y seleccione « Suprimir inmediatamente ».
    3. En el cuadro de diálogo, seleccione Sí, suprimir la clave.
      Este paso es obligatorio, ya que la eliminación es definitiva. Una vez que haya eliminado la clave, no podrá recuperarla.
    4. Pulse Aceptar.

Puede utilizar la clave API nueva o actualizada en la página de documentación interactiva para probar la API de exportación de datos, así como en cualquier aplicación que envíe solicitudes a la API.

Related information:

Cómo trabajar con la API de exportación de datos
Pestaña Claves de API
Claves de API
Tema principal: Cómo trabajar con la API de exportación de datos