Primeros pasos con las interfaz de programación de aplicaciones (API) de Klaviyo

Objetivos del artículo

Obtén una comprensión básica de las llamadas a la interfaz de programación de aplicaciones (API) y de cómo las interfaz de programación de aplicaciones (API) de Klaviyo pueden beneficiar a tu empresa.  En esta guía, aprenderás sobre las interfaces de programación de aplicaciones (API) REST, los métodos HTTP y las herramientas para desarrolladores para prepararte para probar la interfaz de programación de aplicaciones (API) de Klaviyo. Tus primeras llamadas a la interfaz de programación de aplicaciones (API) se pueden realizar en tan solo 10 minutos de principio a fin. Si ya estás familiarizado con las llamadas a la interfaz de programación de aplicaciones (API) y estás listo para probar nuestras interfaz de programación de aplicaciones (API), sigue nuestra guía sobre cómo usar nuestras colecciones de Postman.

¿Qué es una interfaz de programación de aplicaciones (API) REST?

REST interfaz de programación de aplicaciones (API) es un conjunto de siglas que significan Transferencia de Estado Representacional e Interfaz de Programación de Aplicaciones. Estos términos pueden entenderse de forma más sencilla como solicitudes estructuradas que permiten que una pieza de software se comunique con otra y transfiera información entre ellas. Cuando realizas una llamada a la interfaz de programación de aplicaciones (API) de Klaviyo, envías una solicitud a un servidor y recibes una respuesta. La respuesta incluye un código de estado y, cuando el punto de conexión devuelve datos, un cuerpo en formato JSON (JavaScript Object Notation). Algunas solicitudes exitosas no devuelven un cuerpo de respuesta.

En pocas palabras, las interfaz de programación de aplicaciones (API) REST te permiten solicitar almacenamiento de datos en Klaviyo y recibir esos datos en un formato legible para ti y para las computadoras.

Una solicitud GET para recuperar datos sigue estos pasos:

1. Envía una solicitud estructurada de datos a través de internet a la interfaz de programación de aplicaciones (API). Las solicitudes se envían mediante HTTP, un tipo básico de solicitud de red en el que se basa gran parte de internet.
2. La interfaz de programación de aplicaciones (API) recibirá la solicitud, la procesará y obtendrá la información solicitada de las bases de datos de Klaviyo.
3. Luego, la interfaz de programación de aplicaciones (API) responde a la aplicación cliente mediante un formato estructurado en JSON.
4. Recibirás la respuesta JSON de la aplicación cliente.

Aunque este conocimiento es útil para entender cómo funciona la transferencia de datos, no es necesario para empezar a hacer llamadas a la interfaz de programación de aplicaciones (API) y obtener valor de lo que las interfaz de programación de aplicaciones (API) de Klaviyo tienen para ofrecer. Las siguientes secciones explican los conceptos básicos, y la guía de Postman enlazada te guía a través de tu primera llamada a la interfaz de programación de aplicaciones (API).

Métodos HTTP

Los métodos HTTP son los "verbos" mediante los cuales se envían tus solicitudes. En esta guía abordaremos 2 métodos HTTP: GET y POST. 

GET

Una solicitud GET se entiende más fácilmente como una solicitud de "lectura". Las solicitudes GET recuperan información del punto de conexión de la interfaz de programación de aplicaciones (API) endpoint y te la devuelven en una respuesta con formato JSON. Estas solicitudes solo te permiten leer datos, lo que las convierte en el tipo de solicitud más seguro porque tus datos no pueden modificarse ni sobrescribirse con este método.

POST

Una solicitud POST se puede entender simplemente como una solicitud de “escritura”. POST te permite crear o agregar recursos nuevos. Por ejemplo, una solicitud POST a la interfaz de programación de aplicaciones (API) de Listas se puede usar para crear una lista nueva en la cuenta, mientras que las solicitudes GET pueden recuperar las listas página por página. Sigue el enlace a la página siguiente en cada respuesta hasta que no haya más páginas.

Consulta la documentación de referencia del punto de conexión para ver su respuesta de éxito. La creación de una lista devuelve 201 (Created) con los datos de la lista nueva. Algunas solicitudes POST, como crear un evento, devuelven 202 (Accepted) sin cuerpo de respuesta. Una respuesta 202 significa que la solicitud se aceptó para su procesamiento. No confirma que el procesamiento haya finalizado.

Herramientas necesarias

Las interfaz de programación de aplicaciones (API) ofrecen mucha flexibilidad a tus flujos de trabajo y no requieren que uses una aplicación cliente específica ni una biblioteca de lenguaje para lograr los resultados deseados. Como las llamadas a la interfaz de programación de aplicaciones (API) se realizan mediante solicitudes HTTP, casi todos los lenguajes de programación tienen la capacidad de enviar este tipo de solicitud de forma nativa o mediante una biblioteca de lenguaje ampliamente disponible. Además, según tu equipo y sistema operativo, puedes usar aplicaciones nativas como Terminal de Apple o Terminal de Windows para hacer llamadas a la interfaz de programación de aplicaciones (API) desde tu computadora. Sin embargo, estas aplicaciones requieren conocimientos previos de interfaces de línea de comandos.

Usamos una aplicación web y de escritorio gratuita llamada Postman. Postman tiene una variedad de funciones que facilitan configurar y enviar una solicitud de interfaz de programación de aplicaciones (API) al ingresar el punto de conexión, los parámetros y la autenticación en una interfaz de usuario útil.

Prueba las interfaz de programación de aplicaciones (API) de Klaviyo

Usa una cuenta de prueba de Klaviyo para experimentar. Las solicitudes POST pueden cambiar los datos de la cuenta asociada con tus credenciales, incluso cuando las envías desde Postman.

Para las solicitudes que usan una clave de API privada, crea una clave con los permisos requeridos por los puntos de conexión que planeas probar. Por ejemplo, para recuperar listas se requiere lists:read, mientras que para crear una lista se requiere lists:write. Mantén las claves de API privadas seguras y nunca las expongas en el código del navegador.

Las interfaz de programación de aplicaciones (API) de Klaviyo son útiles para enviar datos desde otras plataformas o servidores a cuentas de Klaviyo o consultar información dentro de una cuenta de Klaviyo. Ahora que ya sabes cómo funcionan las interfaz de programación de aplicaciones (API), puedes empezar a probar nuestras interfaz de programación de aplicaciones (API) para los casos de uso de tu empresa. Para ver una lista completa de las interfaz de programación de aplicaciones (API) disponibles de Klaviyo, consulta nuestra documentación de referencia de la interfaz de programación de aplicaciones (API). Sigue nuestra guía sobre cómo usar nuestras colecciones de Postman para hacer tu primera llamada a la interfaz de programación de aplicaciones (API) de Klaviyo.

Recursos adicionales

Recursos del portal para desarrolladores

El portal para desarrolladores de Klaviyo contiene guías de la interfaz de programación de aplicaciones (API) y documentación de referencia para ayudarte a aprovechar al máximo nuestras interfaz de programación de aplicaciones (API). Consulta los recursos a continuación para comenzar:

• Documentación de referencia de la interfaz de programación de aplicaciones (API) de Klaviyo
• Primeros pasos con la interfaz de programación de aplicaciones (API) de JavaScript
• Configuración de eventos transaccionales basados en la interfaz de programación de aplicaciones (API)

Cursos de Klaviyo para desarrolladores

Klaviyo Academy ofrece cursos para desarrolladores que te ayudan a comenzar a crear con las interfaz de programación de aplicaciones (API) de Klaviyo. Consulta los cursos a continuación:

• Fundamentos de la interfaz de programación de aplicaciones (API) para profesionales del marketing
• Certificado de Klaviyo para desarrolladores
• Definir términos comunes de la interfaz de programación de aplicaciones (API)