Cómo crear o clonar una clave privada de API

Objetivos del artículo

Aprende a crear una clave de API privada, que es un identificador único utilizado para las llamadas a la interfaz de programación de aplicaciones (API), así como a definir un ámbito. 

Tanto la clave privada de API como los ámbitos te ayudan a proteger tus datos y los de tus clientes limitando a qué pueden acceder terceros.

Sobre la clave privada de API y los ámbitos

Cuando haces una llamada a una interfaz de programación de aplicaciones (API), permite que un programa se conecte a otro. Esta conexión permite que un programa solicite, edite o añada información al otro.  

Una clave privada de API se asegura de que esta solicitud tiene los permisos adecuados (es decir, que procede de un usuario, cuenta o programa autorizado). Piensa en ello como en una llave de casa: os deja entrar a ti y a tu familia, pero impide la entrada a todos los demás.

Incluir un ámbito para una clave privada de API añade otra capa de autorización, limitando a qué elemento concreto puede acceder un tercero. Los ámbitos son similares a una llave de hotel, sólo te dan acceso a determinadas zonas (como tu habitación o el gimnasio) y no a todo el edificio. 

Tipos de ámbitos

Cuando creas una clave privada de API, debes seleccionar su ámbito. En otras palabras, debes decidir si quieres que lo haga un tercero:

• No tener acceso a una interfaz de programación de aplicaciones (API) punto de conexión.
• Ver todos los datos de una interfaz de programación de aplicaciones (API) punto de conexión, pero sin poder hacer cambios (también llamado "sólo lectura"). 
• Crear, eliminar y realizar otros cambios en cualquier cosa asociada a ese punto de conexión (también llamado "acceso total" o "acceso de escritura").

Por ejemplo, supongamos que quieres añadir un suscriptor a una lista de Klaviyo desde un software de terceros. En ese caso, debes tener acceso total (escritura) a la interfaz de programación de aplicaciones (API) punto de conexión para lista, perfil y perfil de suscripción masiva. Sin embargo, el tercero no necesita acceder a ningún otro punto de conexión. 

Puedes conocer la interfaz de programación de aplicaciones (API) deKlaviyo y ver los ámbitos disponibles para cada punto de conexión en el portal para desarrolladores. 

Antes de empezar

Ten en cuenta lo siguiente: 

• Después de crear una clave privada de API, no puedes:
  • Vuelve a ver la clave privada de API. 
    • Consejo: guarda de forma segura las claves privadas de API y anota para qué quieres utilizarlas, por ejemplo en un gestor de contraseñas. 
  • Añade o edita sus ámbitos. 
    • Si necesitas cambiar de ámbito, la única opción es borrar la clave privada de API original y luego crear una nueva con el ámbito correcto. 
• La clave privada de API tiene acceso total por defecto.

Si no estás seguro de qué interfaz de programación de aplicaciones (API) punto de conexión, ámbitos o permisos necesitas, ponte en contacto con un desarrollador o contacta con un socio deKlaviyo para obtener ayuda. 

Crear una clave privada de API 

1. Haz clic en el nombre de tu organización en la parte inferior izquierda.
2. Navega hasta Ajustes.
3. Haz clic en clave de API.
   
4. Haz clic en Crear clave privada de API.
5. Nombra la clave de API.
6. Elige el ámbito que quieres dar a la clave de API:
   • Solo de lectura
   • Completo
   • Personalizado
     
7. Selecciona Crear.

Ahora, cuando compartas una clave privada de API, el tercero sólo tendrá acceso a la información que hayas definido en el ámbito. 

Utilizar consultas 

Las consultas se utilizan en escenarios avanzados. Si aún no estás familiarizado con las consultas o con cómo utilizarlas, te recomendamos que trabajes con un desarrollador. 

Incluir

Ten en cuenta que si intentas utilizar la consulta de inclusión, tendrás que cambiar el formato de lo indicado anteriormente.

Por ejemplo, el perfil punto de conexión es /interfaz de programación de aplicaciones (API)/perfil.

Sin embargo, si añades el parámetro de consulta include(/interfaz de programación de aplicaciones (API)/perfil?include=lista), también necesitarás lista:read o lista:full access, dependiendo del tipo de llamada a la interfaz de programación de aplicaciones (API) que estés realizando.

Alcances

Utilizando el parámetro ámbitos, puedes crear un parámetro URL para autorellenar qué ámbito de acceso necesitas para tu clave privada de API. 

En la consulta de ámbitos, incluye una lista separada por comas de los ámbitos que quieras preseleccionar. 

Un ejemplo de URL es
https://www.klaviyo.com/create-private-api-key?scopes=campaigns:read,campaigns:write

Navegue hasta nuestro portal para desarrolladores para ver los ámbitos que puede utilizar en esta consulta.

Clonar una clave privada de API

Con la clave privada de API, la clonación te permite crear una nueva clave que tiene los mismos ámbitos y permisos que la clave original.

Ten en cuenta que:

• La clonación no genera la misma clave que la clave privada original de API.
• No puedes renombrar una clave de API clonada; tiene el mismo nombre que la clave original. 

Para clonar una clave privada de API: 

1. Navega hasta la pestaña Clave de API . 
2. Haz clic en el menú de 3 puntos situado junto a la tecla que quieres clonar. 
3. Selecciona Clonar > Clonar. 
   
4. Copia o descarga la nueva clave privada de API y tienda, comercio en un lugar seguro. 
5. Asegúrate de borrar tu antigua clave si ya no la necesitas. 

Recursos adicionales

• Consulta nuestro artículo sobre los primeros pasos con Klaviyo interfaz de programación de aplicaciones (API).
• pagar más documentación para desarrolladores.
• Más información sobre la seguridad de tu cuenta.