Sha256: 7aac1340eecd11cb0ad6e5f146f6dec8bb2cca9af38078b86fa9045e26e12dbb

Contents?: true

Size: 783 Bytes

Versions: 10

Compression:

Stored size: 783 Bytes

Contents

# CiviCRM Client

## Installation

```
$ gem install civicrm
```

## Getting started

```ruby
# Required config
CiviCrm.api_base = "https://www.example.org/path/to/civi/codebase/"
CiviCrm.site_key = "YOUR_SITE_KEY"
CiviCrm.api_key = "..."
```

## CiviCrm Objects

```ruby
# Get list of contacts
CiviCrm::Contact.all

# Create contact
CiviCrm::Contact.create(contact_type: "Organization", organization_name: "test")

# Find and delete
CiviCrm::Contact.find(1).delete
```

## Testing

```
$ bundle exec rspec spec
```

## Useful links

* https://docs.civicrm.org/dev/en/latest/api/interfaces/#rest-interface
* http://drupal.demo.civicrm.org/civicrm/api/explorer

## Acknowledgements

Created by [Iskander Haziev](https://github.com/gvalmon). Maintained by [EFF](https://www.eff.org/).

Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
civicrm-1.3.6 README.md
civicrm-1.3.5 README.md
civicrm-1.3.4 README.md
civicrm-1.3.3 README.md
civicrm-1.3.2 README.md
civicrm-1.3.1 README.md
civicrm-1.2.5 README.md
civicrm-1.2.2 README.md
civicrm-1.2.1 README.md
civicrm-1.2.0 README.md