Keap::REST

Installation

Add this line to your application's Gemfile:

gem 'keap-rest'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install keap-rest

Configuration

Use the configuration object to configure the client:

Keap::REST.configure do |config|
  config.client_id = "my_client_id"
  config.client_secret = "my_client_secret"
  config.redirect_uri = "http://localhost:3000"
end

Using Environment Variables

You can also set th

Authentication

To make calls against the Keap REST API you will need to first obtain an Access Token by requesting authorization, then trading in the resulting code. You will receive a Refresh Token along with it, allowing you to create new Access Tokens as they expire.

Rails Example

In a view file, create a link to the APIs authorization endpoint:

<%= link_to "Get Keap access token", Keap::REST::Token.auth_url %>

If you didn't configure the gem with a default redirect_uri, or you want to override it, you can include it in the method call:

<%= link_to "Get Keap access token", Keap::REST::Token.auth_url(redirect_uri: "http://localhost:3000/auth/keap/callback") %>

In your callback controller, use the code returned by the authorization request to request an Access Token:

class AuthController < ApplicationController
  def keap
    token = Keap::REST::Token.request(code: params[:code])
  end
end

⚠️ If you didn't configure a default redirect_uri for the gem, you must include the same redirect_uri used in your authorization request: Keap::REST::Token.request(code: params[:code], redirect_uri: "http://localhost:3000/auth/keap/callback")

Usage

# Provide authentication credentials
client = Keap::REST::Client.new(access_token: "my_access_token")

# Get current account profile
client.account_profile

# Get a list of contacts
contacts = client.contacts

# …or a single contact
contact = client.contact(42)

Development

After checking out the repo, 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.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/partydrone/keap-rest. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

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

Code of Conduct

Everyone interacting in the Keap::REST project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.