civicrmapi 0.4

Connect with the CiviCRM APIv3 and APIv4 via HTTP and cv.

Description

Clean and simple bindings to CiviCRM’s API. Both API v3 and API v4 are supported. CiviCRM’s API can be accessed either via REST or the command line tool cv.

Installation

pip install civicrmapi

Getting started

There are four ready to use api classes:

• RestApiV3 - REST API bindings for CiviCRM APIv3

• RestApiV4 - REST API bindings for CiviCRM APIv4

• ConsoleApiV3 - Using cv to access CiviCRM APIv3

• ConsoleApiV4 - Using cv to access CiviCRM APIv4

All you need to do is to initialize the api of your choice and use it:

from civicrmapi import ConsoleApiV4

api = ConsoleApiV4(cv='/path/to/cv', cwd='/path/to/civicrm/root')
params = {
    "contact_type": "Organization",
    "organization_name": "pretty org",
    }
result = api.Contact.create(params)

Links

• Repository

• Documentation