solve360 0.9.2
Solve360 API Python wrapper
License: The MIT Licence
Keywords: norada solve360 api wrapper

Solve360 API Python wrapper
===========================

Python wrapper for `Norada CRM Solve360 <http://norada.com/>`__ API.

Solve360 API Documentation
--------------------------

http://norada.com/answers/api/external\_api\_introduction

Installation
------------

::

    $ pip install solve360

Usage
-----

The API methods and parameters are the same for all record types, i.e.
Contacts, Companies and Project Blogs. Simply use the appropriate
segment name for the record type. For example, if creating a:

-  Contact - Use crm.create\_contact()
-  Company - Use crm.create\_company()
-  Projectblog - Use crm.create\_projectblog()

Initiate solve360 object
~~~~~~~~~~~~~~~~~~~~~~~~

::

    >>> from solve360 import Solve360
    >>> crm = Solve360(your_email, your_token)

List contacts
~~~~~~~~~~~~~

::

    >>> crm.list_contacts()
    {u'status': 'success',
     u'count': 2,
     u'12345': {...},
     u'12346': {...}}

`Reference <https://solve360.com/api/contacts/#list>`__

Get contacts - paginated
~~~~~~~~~~~~~~~~~~~~~~~~

The solve360 API have a fixed upper limit on objects each list request
will return, currently set to 5000. To fetch more objects in a single
request this wrapper offers a parameter ``pages``. The request will
continue to fetch objects until either all objects are returned or the
number of given pages have been reached.

::

    >>> contacts = crm.list_contacts(limit=solve360.LIST_MAX_LIMIT, pages=2)
    >>> contacts
    {u'status': 'success',
     u'count': 12000,
     u'12345': {...},
     u'12346': {...}, 
     ...}
    >>> len(contacts)
    10002  # Keys 'status' and 'count' plus 10000 contacts 

Parameter ``pages`` must be a positive number. There is currently no
parameter that fetches all objects available disregard how many there is
totally. Just set ``pages`` to a number high enough to include the
number of objects required.

Show contact
~~~~~~~~~~~~

::

    >>> crm.show_contact(12345)
    {u'status': 'success',
     u'id': 12345,
     u'fields': {...},
     ...}

`Reference <https://solve360.com/api/contacts/#show>`__

Create contact
~~~~~~~~~~~~~~

::

    >>> crm.create_contact({'firstname': 'test', 'lastname': 'creation'})
    {'status': 'success',
     'item': {'id': 12347, ...},
     ...}

`Reference <https://solve360.com/api/contacts/#create>`__

Update contact
~~~~~~~~~~~~~~

::

    >>> crm.update_contact(12345, {'firstname': 'updated', 'lastname': 'name'})
    {'status': 'success',
     'item': {'id': 12345, ...},
     ...}

`Reference <https://solve360.com/api/contacts/#update>`__

Destroy contact
~~~~~~~~~~~~~~~

::

    >>> crm.destroy_contact(12345)
    {'status': 'success'}

`Reference <https://solve360.com/api/contacts/#destroy>`__

Show report activities
~~~~~~~~~~~~~~~~~~~~~~

::

    >>> crm.show_report_activities('2014-03-05', '2014-03-11')
    {u'status': 'success', 
     u'66326826': {u'comments': [],
            u'created': u'2014-03-05T08:48:07+00:00',
            u'fields': {u'assignedto': u'88842777',
            u'assignedto_cn': u'John Doe',
            u'completed': u'0',
            u'duedate': u'2014-03-07T00:00:00+00:00',
            u'priority': u'0',
            u'remindtime': u'0',
        ...}, 
     ...
    }

`Reference <https://solve360.com/api/activity-reports/#show>`__

Error handling
--------------

Successful requests with ``response.status_code == 2XX`` will parse the
json response body and only return the response data in python data
format.

Invalid requests with ``response.status_code == 4XX or 5XX`` will raise
an ``requests.HTTPException`` using requests ``raise_for_status()``
returning the complete stacktrace including server error message if
available.

Test
----

::

    $ pip install pytest httpretty
    $ py.test solve360/tests.py

Dependencies
------------

-  `requests <https://pypi.python.org/pypi/requests>`__
-  `iso8601 <https://pypi.python.org/pypi/iso8601>`__

Testing
~~~~~~~

-  `pytest <https://pypi.python.org/pypi/pytest>`__
-  `httpretty <https://pypi.python.org/pypi/httpretty>`__