CiviCRM Community Forums (archive)

Hi,

We are introducing a new and improved API (v3) in civicrm 3.4 and we strongly suggest you to start using it.

We are keeping for the next version of civicrm (at least) the api V2. Most of the calls are compatible, that's mostly a matter of making things more logical.

You don't have to do anything by default to use the latest API, and if you are using the REST interface, we are suggesting you to test first if it works directly out of the box with the new version.

If it isn't the case, you can probably modify it easily, don't hesitate to post on this forum to ask for help and clarifications

If you want to keep the api v2, you can request it for a specific API by adding a "version" param (2 or 3)

If you want to keep the api v2 for all the requests, you can set in your civicrm.settings.php the version that is called by default:
define( 'CIVICRM_API_VERSION', '3' ); // if this isn't defined, it will be defaulting to 3, but you can set it to 2

We will maintain the v2 api for the next civicrm version at least, but urge you to evaluate the new api and start working on upgrading it.

if you are using the api v2, we are returning an extra param "deprecated", as a kind reminder that really, you should upgrade the software using this API

X+