KlaviyoAPI

The best way to consume Klaviyo's v1 & v2 APIs!

Installation

Add this line to your application's Gemfile

gem 'klaviyo_api'

Usage

Basic Account object

# frozen_string_literal: true

require 'klaviyo_api'

class Account
  attr_accessor :api_key

  def initialize(api_key)
    @api_key = api_key
  end

  def with_klaviyo_session(&block)
    KlaviyoAPI::Session.temp api_key, &block
  end
end

account = Account.new 'pk_xxxyyyzzz'

GET /lists

account.with_klaviyo_session { KlaviyoAPI::List.all }

GET /list/:list_id

account.with_klaviyo_session { KlaviyoAPI::List.find 'AbC123xYz' }

Development

After checking out the repository, run bin/setup to install dependencies. Then, run rake test to run the tests.

You can also run bin/console for an interactive prompt that will allow you to experiment. You can create a file in the root of the project called dev-config.yml and add your API key to it:

api_key: <your-api-key>

This will tell the console to pre-authenticate the Klaviyo session, making it easier to test.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/rewindio/klaviyo_api.