Skip to content

A Ruby gem which helps to communicate with MailerLite API.

License

Notifications You must be signed in to change notification settings

RubyOnWorld/mailerlite-ruby

Repository files navigation

MailerLite API v2 Ruby wrapper

A Ruby gem which helps to communicate with MailerLite API.

Gem Version Coverage Status

Installation

Add this line to your application's Gemfile:

gem 'mailerlite'

Usage

Before making any request, you should authenticate first. Use the response object to make requests afterward. See create a campaign example.

Authentication

When you sign up for an account, you are given an API key. You authenticate to the MailerLite API by providing your API key in the request. You can find your API key in page: Integrations » Developer API.

client = MailerLite::Client.new(api_key: 'my-secret-api-key')

Example:

client.groups

Or create file under config/initializers/mailerlite.rb

MailerLite.configure do |config|
  config.api_key = 'my-secret-api-key'
  # config.timeout = 10
end

When you configured global settings in file, then you can request methods on MailerLite class directly.

Example:

MailerLite.campaigns

See more documentation in examples directory.

Supported Ruby Versions

This library aims to support and is tested against the following Ruby implementations:

  • Ruby 2.6.0
  • Ruby 2.7.0
  • Ruby 3.0.0
  • Ruby 3.1.0
  • Truffleruby

License

The gem is available as open source under the terms of the MIT License.

About

A Ruby gem which helps to communicate with MailerLite API.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published