Cómo crear o clonar una clave API privada

Qué aprenderás

Aprende a crear una clave privada de API, que es un identificador único utilizado para las llamadas a 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 la API, permite que un programa se conecte a otro. Esta conexión permite a un programa informático solicitar, editar o añadir 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 un punto de conexión API.
• Ver todos los datos de un punto de conexión API, 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 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 API deKlaviyo y ver los ámbitos disponibles para cada punto de conexión en el portal de 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 la clave privada de API y anota para qué quieres utilizarla, 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 original de API 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é API punto de conexión, ámbitos o permisos necesitas, ponte en contacto con un desarrollador o contacta con un socio deKlaviyo para que te ayude. 

Crear una clave API privada 

1. Haz clic en el nombre de tu organización en la parte inferior izquierda.
2. Navegue hasta Ajustes.
3. Haga clic en Claves API.
   
4. Haga clic en Crear clave API privada.
5. Nombre la clave API.
6. Elija el ámbito al que desea dar la clave API:
   • Sólo lectura
   • Completo
   • A medida
     
7. Seleccione Crear.

Ahora, cuando comparta una clave de API privada, el tercero sólo tendrá acceso a la información que usted haya 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. 

Incluya

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

Por ejemplo, el punto final de perfiles es /api/profiles.

Sin embargo, si añade el parámetro de consulta include(/api/profiles?include=list), también necesitará list:read o list:full access, dependiendo del tipo de llamada a la API que esté realizando.

Visores

Utilizando el parámetro scopes, puede crear un parámetro URL para autocompletar el acceso al ámbito que necesita para su 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

Clonar una clave API privada

Con las claves API privadas, la clonación le permite crear una nueva clave que tiene los mismos ámbitos y permisos que la clave original.

Tenga en cuenta que:

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

Para clonar una clave API privada: 

1. Navegue hasta la pestaña Claves API . 
2. Haga clic en el menú de 3 puntos situado junto a la tecla que desea clonar. 
3. Seleccione Clonar > Clone. 
   
4. Copia o descarga la nueva clave privada de API y almacénala en un lugar seguro. 
5. Asegúrate de borrar tu antigua clave si ya no la necesitas. 

Recursos adicionales

• Consulte nuestro artículo sobre cómo empezar a utilizar las API de Klaviyo.
• Consulte más documentación para desarrolladores.
• Obtenga más información sobre cómo mantener su cuenta segura.