Cómo crear o clonar una clave de API privada

Qué aprenderás

Descubre cómo crear una clave de API privada, que es un identificador único que se utiliza para las llamadas a la API, así como definir un ámbito.

Tanto las claves de API privadas como los ámbitos te ayudan a proteger tus datos y los de tus clientes al limitar a qué pueden acceder terceros.

Información sobre claves de API privadas y ámbitos

Cuando haces una llamada a la API, permite que un software se conecte a otro. Esta conexión permite que un software solicite, edite o añada información en el otro. 

Una clave de API privada se asegura de que esta solicitud tenga los permisos correctos (es decir, que proviene de un usuario, una cuenta o un programa autorizados). Piénsalo como una llave de casa: te permite entrar a ti y a tu familia, pero mantiene a todo el mundo fuera.

Incluir un alcance para una clave de API privada añade otra capa de autorización, lo que limita a qué elementos específicos puede acceder un tercero. Los alcances son similares a la llave de un hotel: solo te dan acceso a ciertas áreas (como tu habitación o el gimnasio) y no a todo el edificio.

Tipos de ámbitos

Cuando crees una clave de API privada, debes seleccionar su alcance. En otras palabras, debes decidir si quieres que un tercero:

• No tener ningún acceso a un punto de conexión de la API.
• Ver todos los datos de un punto de conexión de API, pero no poder hacer cambios (también llamado «solo lectura»).
• Crea, elimina y realiza otros cambios en cualquier elemento asociado a ese punto de conexión (también llamado «acceso completo» o «acceso de escritura»).

Por ejemplo, supongamos que quieres añadir suscriptores a una lista de Klaviyo desde un software de terceros. En ese caso, debes tener acceso completo (de escritura) a los puntos de conexión de la API para listas, perfiles y la suscripción masiva de perfiles. Sin embargo, el tercero no necesita acceso a ningún otro punto de conexión.

Puedes obtener información sobre las API de Klaviyo y ver los alcances 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 de API privada, no puedes:
  • Ver la clave de API privada de nuevo.
    • Consejo: guarda de forma segura las claves de API privadas y anota para qué quieres usarlas, por ejemplo, en un gestor de contraseñas.
  • Añade o edita sus ámbitos.
    • Si necesitas cambiar los alcances, la única opción es eliminar la clave de API privada original y, después, crear una nueva con el alcance correcto.
• Las claves de API privadas tienen acceso completo de forma predeterminada.

Si no estás seguro de qué puntos de conexión, ámbitos o permisos de API necesitas, ponte en contacto con un desarrollador o pide ayuda a un socio de Klaviyo.

Crear una clave de API privada

1. Haz clic en el nombre de la empresa en la parte inferior izquierda.
2. Ve a Ajustes.
3. Click clave de API.
   

4. Haz clic en Crear clave de API privada.
5. Asigna un nombre a la clave de API.
6. Elige el alcance que quieras dar a la clave de API:
   • Solo lectura
   • Completo
   • Personalizado

7. Selecciona Crear.

Ahora, cuando compartas una clave de API privada, el tercero solo tendrá acceso a la información que definiste en el alcance.

Usar consultas

Las consultas se utilizan en escenarios avanzados. Si no estás familiarizado con las consultas o con cómo usarlas, te recomendamos trabajar con un desarrollador.

Incluir

Ten en cuenta que, si intentas usar la consulta include, tendrás que cambiar el formato con respecto a lo que se indica arriba.

Por ejemplo, el punto de conexión de los perfiles es /api/profiles.

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

Alcances

Con el parámetro scopes, puedes crear un parámetro de URL para autorrellenar el acceso de ámbito que necesitas para tu clave de API privada.

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

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

Ve a nuestro portal de desarrolladores para ver los ámbitos que puedes usar en esta consulta.

Clonar una clave de API privada

Con claves de API privadas, la clonación te permite crear una clave nueva que tenga los mismos alcances y permisos que la clave original.

Ten en cuenta que:

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

Para clonar una clave de API privada:

1. Ve a la pestaña claves de API .
2. Haz clic en el menú de 3 puntos junto a la clave que quieras clonar.
3. Selecciona Clonar > Clonar.
   

4. Copia o descarga la nueva clave de API privada y guárdala en un lugar seguro.
5. Asegúrate de eliminar tu clave antigua si ya no es necesaria.

Recursos adicionales