CiviCRM Community Forums (archive)

This morning (at least in my timezone, for one of us it was evening) we (Eileen, Piotr, Xavier, Michal for some of it and me) had a meeting about the work to be done to get the v3 version of the API out with CiviCRM 3.4. For those of you that are not aware of this, we are making some standardization improvements to the API. Because of backward compatibilty issues we are creating a v3 API, so people can still use the current v2 version for some time.

We decided to create a wiki page that will contain instructions on what has to be done to migrate an API to v3 (will be anounced shortly by Xavier) and a wiki page which lists the API's and functions, where everyone can list their name against an API / function that they are willing to migrate, ideally before Feb 9 2011 (code freeze date for CiviCRM 3.4). So all of you that want to get involved, watch this space and the wiki for further instructions. Your help will be VERY appreciated and is necessary to get the improvements we would like, in the coming weeks and in the future. We can certainly use all the help we can get and more! 

This post is also a request to let the API team know what you need to get involved and lend a hand. We would like as many of you out there involved as possible, and we want to help you to get stuck in! So let us know....


In CiviCRM 3.4 there will be an api.php in the api folder that allows you to call every API with a version parameter. It will look something like this:
function civicrm_api($function, $class, $params){
if (empty($params['version'])){
 $params['version'] = 2;
}

require_once 'api/v' . $params['version'] . '/' . $class .'.php';
$result = $function($params);
return $result;
}

That will allow you to call the api in version 3 or in version 2 mode. So if you want to a civicrm_contact_create and want to use the v2 api, the call will be:

$result = civicrm_api( 'civicrm_contact_create','Contact',$params );
In your $params you set the version parameter to hold the version you want, where the current v2 is the default.

Erik (as a member of the API team)

Yep, that was discussed and will be done