Connect and interface with the OnePageCRM REST API with python
Switch branches/tags
Nothing to show
Clone or download
Latest commit aecd747 Jul 23, 2015
Permalink
Failed to load latest commit information.
onepagecrm added source header Jul 23, 2015
.gitignore Initial commit of client Jul 18, 2014
README.rst edited readme Jul 16, 2015
setup.py change Jul 16, 2015

README.rst

OnePageCRM Python Client

Connect and interface with the OnePageCRM REST API

Installation

pip install onepagecrm

Usage

The first thing to do is to set up your client

from onepagecrm import OnePageCRMAPI, RequestError, UnknownError
client = OnePageCRMAPI.login(username, password)

# If you don't want to store the username and password. After you have a
# working client you can do the following
user_id = client.user_id
api_key = client.api_key
# Save these for later then to create a client
client = OnePageCRMAPI(user_id, api_key)

Once you have your client set up you can start making requests.

Getting data:

contacts = client.get('contacts')['contacts']

# Limit returned data
email_addresses = []
for contact in client.get('contacts', fields='emails', sparse=True)['contacts']:
    emails = contact['contact'].get('emails')
    if emails:
        email_addresses.extend([e.get('value') for e in emails])

# Filter data
contacts = client.get('contacts', if_modified_since='2014-07-10')

# Paginate
contacts = client.get('contacts', page=2, per_page=25)

# Sorting and Ordering
contacts = client.get('contacts', sort_by='modified_at', order='asc')

Create new resources:

contact = client.post('contacts', {'first_name': 'Michael',
                                   'last_name': 'Fitzgerald',
                                   'company_name': 'OnePageCRM'})['contact']
contact_id = contact['id']

text = 'Had a meeting today in cafe 47 with Michael to discuss new features'
note = client.post('notes', {'text': text,
                             'contact_id': contact_id,
                             'date': '2014-07-10'})['note']
note_id = note['id']
# Partial create to autofill missing fields
deal = client.post('deals', {'name': 'Lunch costs',
                             'amount': 12.50,
                             'status': 'won',
                             'contact_id': contact_id},
                            partial=True)['deal']
deal_id = deal['id']

Update existing resources:

contact['background'] = 'CEO of OnePage'
contact = client.put('contacts', contact_id, contact)['contact']

# To do a partial update
update = {'background': 'CEO of OnePageCRM'}
contact = client.patch('contacts', contact_id, update)['contact']

# To attach a note to a deal
client.patch('notes', note_id, {'linked_deal_id': deal_id'})

Delete resources you no longer need:

client.delete('deals', deal_id)
client.delete('contacts', contact_id)
# To undo the deletion of a contact
client.delete('contacts', contact_id, undo=True)