Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
:email: An OmniAuth strategy for authenticating with the Campaign Monitor API.
Ruby
Branch: master

README.md

OmniAuth CreateSend

This is the OmniAuth strategy for authenticating with the Campaign Monitor API. You'll need to register an OAuth Application in your Campaign Monitor account to get a Client ID and Client Secret to use with this OmniAuth strategy.

Installing

Add a dependency to your Gemfile then bundle install.

gem "omniauth-createsend"

Basic Usage

In Rack applications:

use OmniAuth::Builder do
  provider "createsend", ENV["CREATESEND_CLIENT_ID"], ENV["CREATESEND_CLIENT_SECRET"], :scope => "ViewReports,CreateCampaigns,SendCampaigns"
end

In Rails applications:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider "createsend", ENV["CREATESEND_CLIENT_ID"], ENV["CREATESEND_CLIENT_SECRET"], :scope => "ViewReports,CreateCampaigns,SendCampaigns"
end

This gem also includes an example Rack application which demonstrates how to authenticate with the Campaign Monitor API using this OmniAuth strategy.

Once you've authenticated, you should use the createsend gem to access Campaign Monitor resources.

Contributing

Please check the guidelines for contributing to this repository.

This stuff should be green

Build Status Coverage Status Dependency Status Gem Version

Something went wrong with that request. Please try again.