Cómo crear o clonar una clave de API privada

Objetivos del artículo

Aprende a crear una clave de API privada, que es un identificador único que se usa para llamadas de interfaz de programación de aplicaciones (API), además de definir un alcance.

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

Acerca de las claves de API privadas y los alcances

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

Una clave de API privada garantiza que esta solicitud tenga los permisos correctos (es decir, que provino de un usuario, una cuenta o un programa autorizados). Piensa en ella como si fuera la llave de una casa: permite que tú y tu familia entren, pero mantiene fuera a los demás.

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

Tipos de alcances

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

• No tener acceso a un punto de conexión de una interfaz de programación de aplicaciones (API).
• Ver todos los datos de un punto de conexión de una interfaz de programación de aplicaciones (API), pero no poder hacer cambios (también conocido como “solo lectura”).
• Crea, elimina y haz otros cambios en cualquier cosa asociada con ese punto de conexión (también llamado “acceso total” o “acceso de escritura”).

Por ejemplo, digamos que quieres agregar 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 interfaz de programación de aplicaciones (API) para listas, perfiles y suscripción masiva de perfiles. Sin embargo, el tercero no necesita acceso a ningún otro punto de conexión.

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

Si no sabes con certeza qué puntos de conexión, alcances o permisos de la interfaz de programación de aplicaciones (API) necesitas, comunícate con un desarrollador o contacta a un socio de Klaviyo para obtener ayuda.

Crear una clave de API privada

1. Haz clic en el nombre de tu organización en la parte inferior izquierda.
2. Ve a Configuración.
3. Click clave de API.
   

4. Haz clic en Crear una clave de API privada.
5. Asigna un nombre a la clave de API.
6. Elige el alcance que quieres darle a la clave de API:
   • Solo de 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 usan en escenarios avanzados. Si aún 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 perfiles es /api/profiles.

Sin embargo, si agregas 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 interfaz de programación de aplicaciones (API) que hagas.

Alcances

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

En la consulta de alcances, incluye una lista de los alcances que quieres preseleccionar, separados por comas.

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

Ve al portal para desarrolladores para ver los alcances que puedes usar en esta consulta.

Clonar una clave de API privada

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

Ten en cuenta lo siguiente:

• 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. Navega hasta la pestaña Claves de API .
2. Haz clic en el menú de 3 puntos junto a la clave que quieres 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 la clave anterior si ya no es necesaria.

Recursos adicionales