Guia de introdução às APIs da Klaviyo
O que você vai aprender
Tenha uma compreensão básica de chamadas de API e de como as APIs da Klaviyo podem beneficiar sua empresa. Neste guia, você vai aprender sobre APIs REST, métodos HTTP e ferramentas de desenvolvedor para se preparar para testar as APIs do Klaviyo. Você pode fazer suas primeiras chamadas de API em apenas 10 minutos, do início ao fim. Se você já está familiarizado com chamadas de API e está pronto para testar nossas APIs, siga nosso guia sobre como usar nossas coleções do Postman.
Ao longo deste guia, vamos incluir links para um glossário quando novos termos técnicos forem apresentados. Se você tiver dúvidas sobre o significado de alguma palavra em qualquer momento do guia, confira o glossário de termos técnicos.
O que é uma API REST?
REST API é um conjunto de siglas que significa Representational State Transfer e Application Programming Interface. Esses termos podem ser entendidos de forma mais simples como solicitações estruturadas que permitem que um software se comunique com outro e transmitam informações entre eles. Quando você faz uma chamada à API da Klaviyo, você envia uma solicitação para um servidor e recebe uma resposta. A resposta inclui um código de status e, quando o ponto de extremidade retorna dados, um corpo no formato JSON (JavaScript Object Notation). Algumas solicitações bem-sucedidas não retornam corpo de resposta.
De forma mais simples, as API REST permitem que você solicite o armazenamento de dados no Klaviyo e receba esses dados em um formato legível para você e para computadores.
Uma solicitação GET para recuperar dados segue estas etapas:
- Envie 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 no qual grande parte da internet se baseia.
- A API receberá a solicitação, vai processá-la e obter as informações solicitadas nos bancos de dados da Klaviyo.
- Em seguida, a API responde ao aplicativo cliente usando o formato estruturado em JSON.
- Você 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 extrair valor do que as APIs da Klaviyo têm a oferecer. As seções a seguir explicam o básico, e o guia do Postman, no link, orienta você na sua primeira chamada de API.
Métodos HTTP
Os métodos HTTP são os “verbos” pelos quais suas solicitações são enviadas. Há 2 métodos HTTP que vamos abordar neste guia: GET e POST.
Embora não vamos usá-los aqui, vale observar que a maioria das APIs REST oferece suporte a métodos HTTP adicionais, como PUT, PATCH e DELETE.
GET
Uma solicitação GET pode ser mais facilmente entendida como uma solicitação de "leitura". As solicitações GET recuperam informações do ponto de extremidade da API e retornam essas informações em uma resposta formatada em JSON. Essas solicitações permitem apenas a leitura de dados, o que as torna o tipo de solicitação mais seguro, porque seus dados não podem ser modificados nem sobrescritos com esse método.
POST
Uma solicitação POST pode ser entendida simplesmente como uma solicitação de “gravação”. O POST permite que você crie ou adicione novos recursos. Por exemplo, uma solicitação POST à API de Listas pode ser usada para criar uma nova lista na sua conta, enquanto as solicitações GET podem recuperar suas listas página por página. Siga o link da próxima página em cada resposta até não haver mais páginas.
Confira a documentação de referência do ponto de extremidade para ver a resposta de sucesso. Criar uma lista retorna 201 (Created) com os dados da nova lista. Algumas solicitações POST, como criar um evento, retornam 202 (Accepted) sem corpo de resposta. Uma resposta 202 significa que a solicitação foi aceita para processamento. Isso não confirma que o processamento foi concluído.
Ferramentas necessárias
As APIs oferecem bastante flexibilidade aos seus fluxos de trabalho e não exigem que você use um aplicativo cliente específico nem uma biblioteca de linguagem para alcançar os resultados desejados. Como as chamadas de API são feitas usando solicitações HTTP, quase toda linguagem de programação consegue enviar esse tipo de solicitação nativamente ou por meio de uma biblioteca de linguagem amplamente disponível. Além disso, dependendo da sua máquina e do seu sistema operacional, você pode usar aplicativos nativos como o Terminal da Apple ou o Terminal do Windows para fazer chamadas de API a partir do seu computador. No entanto, esses aplicativos exigem conhecimento prévio de interfaces de linha de comando.
Usamos um aplicativo gratuito para web e desktop chamado Postman. O Postman tem uma variedade de recursos que facilitam configurar e enviar uma solicitação de API, inserindo o ponto de extremidade, os parâmetros e a autenticação em uma interface útil.
Teste as APIs da Klaviyo
Use uma conta de teste do Klaviyo para fazer experimentos. Solicitações POST podem alterar dados na conta associada às suas credenciais, mesmo quando você as envia pelo Postman.
Para solicitações que usam uma chave de API privada, crie uma chave com as permissões exigidas pelos pontos de extremidade que você planeja testar. Por exemplo, recuperar listas exige lists:read, enquanto criar uma lista exige lists:write. Mantenha as chaves de API privadas seguras e nunca as exponha no código do navegador.
As APIs da Klaviyo são úteis para enviar dados de outras plataformas ou servidores para contas da Klaviyo ou consultar informações em uma conta da Klaviyo. Agora que você já entende como as APIs funcionam, pode começar a testar nossas APIs para os casos de uso da sua empresa. Para ver uma lista completa das APIs disponíveis da Klaviyo, confira nossa documentação de referência de API. Siga nosso guia sobre como usar nossas coleções do Postman para fazer sua primeira chamada de API da 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 ajudar você a aproveitar ao máximo nossas API. Confira os recursos abaixo para começar:
- Documentação de referência da API da Klaviyo
- Guia de introdução à API JavaScript
- Como configurar eventos transacionais baseados em API
Cursos do Klaviyo Developers
A Klaviyo Academy oferece cursos para desenvolvedores para ajudar você a começar a criar com as APIs da Klaviyo. Confira os cursos abaixo: