Ruby API client for ONTRAPORT
Overview
This Gem implements ONTRAPORT's JSON REST API - that's a lot of capitals... but it's how they stylize their name :)
So far, all the objects API methods are supported. Forthcoming releases will add support for the other APIs.
Full documentation available here.
Usage
Ontraport.get_object :contact, 12345
#=> #<Ontraport::Response @data=...>
Ontraport.save_or_update :contact, { email: 'foo@bar.com', firstname: 'Foo' }
#=> #<Ontraport::Response @data=...>
Ontraport.tag_objects :contact, { add_list: '11111,22222', ids: '33333,44444' }
#=> #<Ontraport::Response @data=...>
See documentation for more details/examples.
Installation
Bundler
Add the Ontraport gem to your Gemfile:
gem 'ontraport', '~> 0.1'
Manual
Install the Gem from your terminal -
gem install ontraport
Configuration
In Rails, use an initializer to configure -
# config/initializers/ontraport.rb
require 'ontraport'
Ontraport.configure do |config|
config.api_id = 'foo'
config.api_key = 'bar'
end
Contact
If you have a suggestion or a bug report, please file an issue.
License
The project uses the MIT License. See LICENSE.md for details.