Python Interactions with Base

How it works

This client is meant to be as simple to use as possible, mimicking the GET/POST/PUT/DELETE requests documented in the base api documentation. Please review that documentation for required parameters

To set up a connection to base, simply run:

from base_client import BaseAPIService
base_conn = BaseAPIService(email="YOUR_EMAIL", password="YOUR_PASSWORD")

# This will set up a service that returns json responses.  To return xml, add the argument format='xml'

Then you can start working with base objects immediately. Examples (assuming you have instantiated base_conn as above).

Examples of getting objects:

# Return the first page of incoming deals (output will be a json response)
base_conn.get_deals(page=1, stage='incoming')

# Return the first page of contacts (output will be a json response)
base_conn.get_contacts(page=1)

Example creation and modification of contact:

# Create a new contact (json object will be stored as a response)
response = base_conn.create_contact(contact_info={'first_name': 'John', 'last_name': 'Doe'})

# Get the id of the new contact
import json
response_dict = json.loads(response)
contact_id = response_dict['contact']['id']

# Update the contact's phone number
base_conn.update_contact(contact_info={'phone': '555-555-5555'}, contact_id=contact_id)

Important Variables:

• CONTACT_PARAMS - a dictionary of legal parameters for a contact in the contact_info argument. See the base api documentation for required parameters.
• DEAL_PARAMS - a dictionary of legal parameters for a deal in deal_info argument. See the base api documentation for required parameters.
• DEAL_STAGES - legal options for stage argument in get_deals

Available methods:

Please see the code itself for documentation - function headers are reasonably descriptive. Currently, the module has limited functionality.

Accounts Functions:

• get_accounts()

Deals Functions:

• get_deals(page=1, stage='incoming')
• get_deal(deal_id)
• create_deal(deal_info)
• update_deal(deal_info, deal_id)
• update_deal_tags(deal_id, tags, action='add') (other actions are "remove" or "replace")
• create_deal_note(deal_id, note_content)
• update_deal_note(self, deal_id, note_content, note_id)

Contacts Functions:

• get_contacts(page=1)
• get_contact(contact_id)
• create_contact(self, contact_info, person=True)
• update_contact(self, contact_info, contact_id, person=True)
• update_contact_tags(contact_id, tags, action='add') (other actions are "remove" or "replace")
• create_contact_note(self, contact_id, note_content)
• update_contact_note(self, contact_id, note_content, note_id)

Sources Functions:

• get_sources(self, other=0)

Ongoing Development:

This was put together relatively quickly. There are a couple of areas where improvements will be necessary:

• Error handling
• Filling out methods to deal with all types of objects

Feel free to get involved if you want.