CiviCRM Community Forums (archive)

*

News:

Have a question about CiviCRM?
Get it answered quickly at the new
CiviCRM Stack Exchange Q+A site

This forum was archived on 25 November 2017. Learn more.
How to get involved.
What to do if you think you've found a bug.



  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Support »
  • Using CiviCRM »
  • Using Core CiviCRM Functions (Moderator: Yashodha Chaku) »
  • crmAPI documentation and reference?
Pages: [1]

Author Topic: crmAPI documentation and reference?  (Read 867 times)

marthirial

  • I’m new here
  • *
  • Posts: 7
  • Karma: 0
crmAPI documentation and reference?
November 15, 2010, 03:22:42 pm
I am trying to modify the default summary tab and decided to use the crmAPI to display information like membership and custom fields without having to navigate to other tabs.

Although I understand the principle how the crmAPI works, I have a hard time guessing what the available entities and items are as I cannot find a reference.

The single page explaining how the crmAPI works in the documentation only makes reference to the civicrm api v2 but still cannot bring any data into the summary.

Is there a place where I can find which entity and item I should use to get the correct data?  Is this something that it is kept secret so developers can make money off it?  I don't know if I am looking in the wrong place but it is strange no documentation exists for something as basic as customizing a template.

I am using civiCRM v 3.2 for Joomla 1.5

Thanks in advance.

Donald Lobo

  • Administrator
  • I’m (like) Lobo ;)
  • *****
  • Posts: 15963
  • Karma: 470
    • CiviCRM site
  • CiviCRM version: 4.2+
  • CMS version: Drupal 7, Joomla 2.5+
  • MySQL version: 5.5.x
  • PHP version: 5.4.x
Re: crmAPI documentation and reference?
November 15, 2010, 07:31:55 pm
crmAPI is just a very thin smarty function which is layered on top of the CiviCRM API. The crmAPI page should make this fairly clear, if it does not please update the wiki page to and do the needful :)

You can find fairly detailed documentation on the API here:

http://wiki.civicrm.org/confluence/display/CRMDOC32/CiviCRM+Public+APIs

There are also a lot of unit tests in our svn:

http://svn.civicrm.org/civicrm/branches/v3.2/tests/phpunit/api/v2/

lobo

« Last Edit: November 15, 2010, 07:55:51 pm by Donald Lobo »
A new CiviCRM Q&A resource needs YOUR help to get started. Visit our StackExchange proposed site, sign up and vote on 5 questions

xavier

  • Forum Godess / God
  • I’m (like) Lobo ;)
  • *****
  • Posts: 4453
  • Karma: 161
    • Tech To The People
  • CiviCRM version: yes probably
  • CMS version: drupal
Re: crmAPI documentation and reference?
November 15, 2010, 10:52:28 pm
The API & hook forum is a better one than using CiviCRM to get more info. The first post should provide you some pointers:
http://forum.civicrm.org/index.php/topic,15550.msg66632.html#msg66632


Quote from: marthirial on November 15, 2010, 03:22:42 pm
I am trying to modify the default summary tab and decided to use the crmAPI to display information like membership and custom fields without having to navigate to other tabs.


Probably the easiest indeed.

Quote from: marthirial on November 15, 2010, 03:22:42 pm
Is there a place where I can find which entity and item I should use to get the correct data?  Is this something that it is kept secret so developers can make money off it? 

Did you uncover a conspiracy ? Luckily, you can make the parameters less secret and add in the wiki all the secrets you found ;)

All the apis have the same parameters, with a slightly different syntax. We did try documenting one (using mostly the php API), but whatever you read will work as well;

Start by reading the relevant sections in the book we wrote and is available online (for free)
http://en.flossmanuals.net/CiviCRM/DevelopAPI

Oh, and as you mentioned money, feel free to buy the printed version, the money goes directly into funding more dev and documentation  ;)

X+

-Hackathon and data journalism about the European parliament 24-26 jan. Watch out the result

Pages: [1]
  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Support »
  • Using CiviCRM »
  • Using Core CiviCRM Functions (Moderator: Yashodha Chaku) »
  • crmAPI documentation and reference?

This forum was archived on 2017-11-26.