OnePageCRM
This gem is a basic wrapper around the OnePageCRM API.
It does not abstract all API calls to ruby methods on the gem object but simply gives the GET
, POST
, PUT
and DELETE
methods.
The gem handles all the authentication with the OnePageCRM API.
Installation
Add this line to your application's Gemfile:
gem 'onepagecrm'
And then execute:
$ bundle
Or install it yourself as:
$ gem install onepagecrm
Usage
You can try out the OnePageCRM gem in an interactive ruby session
$ irb
irb:> require 'onepagecrm'
irb:> api_client = OnePageCRM.new('user_id', 'api_key')
irb:> api_client.get('contacts.json')
irb:> api_client.post('contacts.json', {'last_name': 'Bravo', 'first_name': 'Johnny'} )
Take a look at the OnePageCRM Developer site for more details on API functionality.
Support
The best way to get support is through the OnePageCRM Developer Forum
Contributing
We welcome any contributions.
- Create an issue relating to the feature that you require.
- Fork the repo ( https://github.com/[my-github-username]/onepagecrm/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request