Ad
More Related Content
What's hot (20)
Similar to CiviCRM API v3 (20)
Ad
Recently uploaded (20)
Ad
CiviCRM API v3
- 1. API v3 It does everything except make warm beer
- 2. What are we going to cover? What problem does it solve? Concepts and tools A Pretty Intuitive example A feel for the cutting edge Advanced example The future is looking at you Q/A ?
- 3. What problem does it solve? Synchronising with an external system Adding a custom workflow Developing a new interface Changing the default behaviour Any time you need to Create Read Update or Delete... almost anything (contact, event, contribution...) Learn it once, use it everywhere
- 4. What is the API A standardised way of accessing data in CiviCRM through code More future proof than SQL or using internal functions The most supported way to interact with CiviCRM data from custom code Better tested (1200 tests and counting...)
- 5. What does an API call look like? Entity Action Params Contact (or one of 45 others!) Get, Create, Delete, Replace, getcount, getsingle, getvalue, Array of relevant variables API Explorer: /civicrm/ajax/doc List of params: /civicrm/api/doc (as of the next version)
- 6. 4 ways of accessing APIs PHP code REST {crmAPI} Ajax .crmAPI() PHP OO
- 7. A Pretty Intuitive example Functional requirement: Society visits companies in various countries, at the moment the visiting agents send in a report of the visit by email. This should be done online Solution in CiviCRM: ?
- 8. Cheat Sheet Use the profile to get a list of companies to visit and the ability to change the company details Adda custom data set with activities of a specific type to hold the additional data Use a hook to enhance the profile with additional data Use the API to add companies to a group and create an activity
- 9. The profile Profiles are a standard feature of CiviCRM Can be used to access or update CiviCRM data from 'outside' In this case, the standard contact profile gives me a list of companies and a possibility to update the company details (address etc.) But I need more......
- 10. The hook I need to add additional data to the profile, and I use CiviCRM hooks to do that Hooks can be used to insert your own code and processing in the CiviCRM processing In this case I used the buildForm hook to add data to the profile, and use the API to retrieve some additional contact data that is not on the profile: $contactParms = array( 'version' => 3, 'check_permissions' => false, 'contact_id' => $userID); $result = civicrm_api( "Contact","get", $contactParms );
- 11. The API Finally the API is used to 'automatically' create an activity for the company and the visitor: $activityParms = array( 'version' => 3, 'check_permissions' => false, 'source_contact_id' => $sourceID, 'target_contact_id' => $id, 'activity_type_id' => 32, 'subject' => "Bezoekverslag website", 'details' => "blahblah", 'status_id' => 2, 'activity_date_time' => $activityDate, 'custom_35' => $veranderingJn); $result = civicrm_api( 'Activity', 'Create', $activityParms );
- 12. Pop quiz for the free beer - is it possible to create a participant record with a linked contribution in a single API call
- 13. "yes, use API Chaining" API Chaining passes the results from 1 API call into another. API chaining relies on the fact that useless values are dropped by the receiving function If the chained function is the same as the higher level function 'id' is passed through from the higher function otherwise the id is passed through as '$entity_id' AND as 'entity_id', 'civicrm_entity' is also set. 'version' & 'sequential' are always set http://svn.civicrm.org/civicrm/branches/v3.4/api/v3/examples/Participant/CreateParticipantPayment.php
- 14. The problem Garbage in/Garbage Out Nothing in/ Nothing out My users are too lazy to open a browser I'm even lazier than they are
- 15. The solution ? Introducing … Your personnal assistant Always awake That knows everything Always ready to take a note
- 16. Miss MoneyPenny From XMPP, with love
- 17. Planned features Extensible API new entities new actions More complete same filters/options everywhere more sort criteria improve underlying BAOs We need you! More tests a test is a contract, if you use the api in a different way, write a test and contribute
- 18. Testing The API is heavily tested but there are still a lot of features not covered. If you want it to work after your next upgrade ... help make sure it's tested
- 19. Recent features Chaining Extra functions getsingle getvalue (needs return=array('valuename') getcount replace format.only_id format.is_success sequential These are implemented in the 'wrapper' function & work across all API
- 20. Recent features (in the generic API) These functions work on some API and are being implemented across them (as tests are written ) . options('limit'); options('sort'); options('sort'); strtotime date handling (e.g. 6 months ago); filters e.g. 'filters' => array( 'activity_date_time_high' => '20120101000000' , ),