Primeros pasos con las API de Klaviyo
Qué aprenderás
Obtén una comprensión básica de las llamadas a la API y de cómo las API de Klaviyo pueden beneficiar a tu empresa. En esta guía, aprenderás sobre las API REST, los métodos HTTP y las herramientas para desarrolladores para prepararte para probar las API de Klaviyo. Tus primeras llamadas a la API se pueden completar en tan solo 10 minutos de principio a fin. Si ya estás familiarizado con las llamadas a la API y estás listo para probar nuestras API, sigue nuestra guía sobre cómo usar nuestras colecciones de Postman.
A lo largo de esta guía, incluiremos enlaces a un glosario cuando se presenten nuevos términos técnicos. Si en algún momento de la guía no tienes claro el significado de una palabra, consulta el glosario de términos técnicos.
¿Qué es una API REST?
La REST API es un conjunto de siglas que significan Representational State Transfer e Application Programming Interface. Estos términos se pueden entender más fácilmente como solicitudes estructuradas que permiten que un software se comunique con otro y transfiera información entre ambos. Cuando realizas una llamada a la 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 correctas no devuelven ningún cuerpo de respuesta.
En pocas palabras, las API REST te permiten solicitar datos almacenados en Klaviyo y recibir esos datos en un formato legible para ti y para los ordenadores.
Una solicitud GET para recuperar datos sigue estos pasos:
- Envía una solicitud estructurada de datos a través de internet a la API. Las solicitudes se envían a través de HTTP, un tipo de solicitud de red básica en el que se basa en gran medida internet.
- El API recibirá la solicitud, la procesará y obtendrá la información solicitada de las bases de datos de Klaviyo.
- A continuación, la API responde a la aplicación cliente usando el formato estructurado de JSON.
- Recibirás la respuesta JSON de tu 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 API y obtener valor de lo que ofrecen las API de Klaviyo. 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 API.
Métodos HTTP
Los métodos HTTP son los «verbos» mediante los cuales se envían tus solicitudes. Hay 2 métodos HTTP que trataremos en esta guía: GET y POST.
Aunque aquí no los usaremos, conviene señalar que la mayoría de las API REST admiten métodos HTTP adicionales, como PUT, PATCH y DELETE.
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 API 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, ya que tus datos no se pueden modificar ni sobrescribir con este método.
POST
Una solicitud POST se puede entender simplemente como una solicitud de «escritura». POST te permite crear o añadir recursos nuevos. Por ejemplo, una solicitud POST a la 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. Al crear una lista se devuelve 201 (Created) con los datos de la nueva lista. 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 se haya completado.
Herramientas necesarias
Las API ofrecen mucha flexibilidad a los flujos de trabajo y no requieren que uses una aplicación cliente específica ni una biblioteca de lenguajes para lograr los resultados deseados. Como las llamadas a API se hacen mediante solicitudes HTTP, casi todos los lenguajes de programación pueden enviar este tipo de solicitud de forma nativa o mediante una biblioteca de lenguajes ampliamente disponible. Además, según la máquina y el sistema operativo, puedes usar aplicaciones nativas como Terminal de Apple o Terminal de Windows para hacer llamadas a API desde el ordenador. 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 API introduciendo el punto de conexión, los parámetros y la autenticación en una interfaz de usuario útil.
Probar las API de Klaviyo
Usa una cuenta de prueba de Klaviyo para hacer pruebas. Las solicitudes POST pueden cambiar los datos de la cuenta asociada a 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 que requieren 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 API de Klaviyo son útiles para enviar datos desde otras plataformas o servidores a cuentas de Klaviyo o para consultar información dentro de una cuenta de Klaviyo. Ahora que ya sabes cómo funcionan las API, puedes empezar a probar nuestras API para los casos de uso de tu empresa. Para ver una lista completa de las API disponibles de Klaviyo, consulta nuestra documentación de referencia de la API. Sigue nuestra guía sobre cómo usar nuestras colecciones de Postman para hacer tu primera llamada a la API de Klaviyo.
Recursos adicionales
Recursos del portal de desarrolladores
El portal de desarrolladores de Klaviyo contiene guías de API y documentación de referencia para ayudarte a sacar el máximo partido a nuestras API. Echa un vistazo a los recursos de más abajo para comenzar:
- Documentación de referencia de la API de Klaviyo
- Primeros pasos con la API de JavaScript
- Configurar eventos transaccionales basados en API
Cursos de Klaviyo Developers
Klaviyo Academy ofrece cursos para desarrolladores para ayudarte a empezar a crear con las API de Klaviyo. Echa un vistazo a los cursos a continuación: