Primeiros passos com as APIs da Klaviyo

O que você vai aprender

Obtenha uma compreensão básica das chamadas de API e de como as APIs da Klaviyo podem beneficiar sua empresa.  Neste guia, o senhor aprenderá sobre APIs REST, métodos HTTP e ferramentas de desenvolvedor para se preparar para testar as APIs da Klaviyo. Suas primeiras chamadas à API podem ser realizadas em apenas 10 minutos, do início ao fim. Se o senhor já estiver familiarizado com as chamadas de API e estiver pronto para testar nossas APIs, siga nosso guia sobre como usar nossas coleções Postman.

O que é uma API REST?

REST API é um conjunto de acrônimos que significa Representational State Transfer (Transferência de estado representacional) e Application Programming Interface (Interface de programação de aplicativos). Esses termos podem ser entendidos de forma mais simples como solicitações estruturadas que permitem que um software converse com outro e passe informações entre eles. Quando o senhor faz uma chamada de API, está enviando uma solicitação a um servidor onde as informações são armazenadas, que retorna uma resposta contendo os dados solicitados no formato JSON, ou JavaScript Object Notation.

Em termos mais simples, as APIs REST permitem que o usuário solicite dados armazenados na Klaviyo e que esses dados lhe sejam devolvidos em um formato que possa ser lido pelo usuário e por computadores. 

Uma chamada de API padrão ocorre em segundos. Nos bastidores, sua chamada será:

1. Enviar uma solicitação estruturada de dados pela Internet para a API. As solicitações são enviadas via HTTP, um tipo básico de solicitação de rede que é a base da Internet.
2. A API receberá a solicitação, a processará e obterá as informações solicitadas dos bancos de dados da Klaviyo.
3. Em seguida, a API responde ao aplicativo cliente usando o formato estruturado JSON.
4. O senhor receberá a resposta JSON do seu aplicativo cliente.

Embora esse conhecimento seja útil para entender como funciona a transferência de dados, ele não é necessário para começar a fazer chamadas de API e obter valor do que as APIs da Klaviyo têm a oferecer. Tudo o que o senhor precisa saber para começar a fazer suas primeiras chamadas à API será abordado nas seções a seguir.

Métodos HTTP

Os métodos HTTP são os "verbos" pelos quais suas solicitações são enviadas. Há dois métodos HTTP que abordaremos neste guia: GET e POST.  

OBTER

Uma solicitação GET pode ser entendida mais facilmente como uma solicitação de "leitura". As solicitações GET recuperam informações do endpoint da API e as retornam ao senhor em uma resposta formatada em JSON. Essas solicitações só permitem que o senhor leia dados, o que as torna o tipo mais seguro de solicitação, pois os dados não podem ser modificados ou substituídos por esse método.

POST

Uma solicitação POST pode ser entendida simplesmente como uma solicitação de "gravação". O POST permite que o senhor crie ou adicione novos recursos. Por exemplo, uma solicitação POST para a API List pode ser usada para criar uma nova lista em sua conta, enquanto uma solicitação GET pode ser usada para recuperar todas as listas disponíveis. Observe que, ao publicar dados, as respostas variam dependendo de quando a Klaviyo pode concluir sua solicitação.

Ferramentas necessárias

As APIs oferecem muita flexibilidade aos seus fluxos de trabalho e não exigem que o senhor use um aplicativo cliente ou uma biblioteca de linguagem específica para obter os resultados desejados. Como as chamadas de API são feitas usando solicitações HTTP, quase todas as linguagens de programação podem enviar esse tipo de solicitação nativamente ou por meio de uma biblioteca de linguagem amplamente disponível. Além disso, dependendo da máquina e do sistema operacional, o senhor pode usar aplicativos nativos como o Terminal da Apple ou a Linha de Comando do Windows para fazer chamadas de API no lado do cliente. No entanto, esses aplicativos exigem conhecimento prévio das interfaces de linha de comando.

Usamos um aplicativo gratuito da Web e de desktop chamado Postman.  O Postman tem uma variedade de recursos que facilitam a configuração e o envio de uma solicitação de API inserindo o endpoint, os parâmetros e a autenticação em uma interface de usuário útil.

Testar as APIs do Klaviyo

As APIs da Klaviyo são úteis para enviar dados de outras plataformas ou servidores para as contas da Klaviyo ou para consultar informações dentro de uma conta da Klaviyo. Agora que o senhor já sabe como as APIs funcionam, pode começar a testar nossas APIs para os casos de uso da sua empresa. Para obter uma lista completa das APIs disponíveis da Klaviyo, consulte nossa documentação de referência de API. Siga nosso guia sobre como usar nossas coleções Postman para fazer sua primeira chamada à API do Klaviyo.

Recursos adicionais

Recursos do portal do desenvolvedor

O portal do desenvolvedor da Klaviyo contém guias de API e documentação de referência para ajudá-lo a tirar o máximo proveito de nossas APIs. Confira os recursos abaixo para começar:

• Documentação de referência da API do Klaviyo
• Primeiros passos com a API Javascript
• Configuração de eventos transacionais baseados em API

Cursos para desenvolvedores do Klaviyo

A Klaviyo Academy oferece cursos para desenvolvedores para ajudá-lo a começar a criar APIs com a Klaviyo. Confira os cursos abaixo:

• Certificado de desenvolvedor do Klaviyo
• Definir termos comuns de API
• Desenvolver conhecimento básico de API
• Mapeie seus dados no Klaviyo