CiviCRM Community Forums (archive)

Is there documentation on the REST interface that's present in 2.0?  I've been looking at its code a little, and I'd like to try to use it to link together a couple of our systems, but I can't find any docs in the Wiki.  Am I missing something or is the wiki?

Happily (unlike last time we talked about this, I actually know some of what I want).  Where should I do that?

Aaron

I finally got something up here, sorry it took so long to get so little done.

Aaron

sorry for the non-response. we've been a bit busy with some trainings and our current NZ meetup hack-a-thon

I think the next step would be to flush out in a more detail the API's you'd like. Given that, we can start building our web services API layer.

Initially i think, our web services layer will be a small group of api's that create/update top level contact data. We'd like the functions to be small and granular and hopefully can construct the web services layer to directly use the BAO functions (which is moving towards being the default API)

We'd also like to use this opportunity to do TDD (test driven development) and build the unit tests before we actually write code for the web services layer. We've been using SimpleTest so far, and would like to continue doing so, and potentially use some of drupal's improvements to it

lobo

apologies for the delay, the NZ meetup is proving to be quite productive and time consuming.

I looked through your use case scenario and looks like we cover a most of your needs with regard to the current version of the api. API documentation is here: http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs

There are a few things which we still need to do:

1. build a REST wrapper around it. I experimented with it in v1.x and the code is at extern/rest.php. You should take a look at it and see if you can get it up and running. I'm a bit hosed till may 10th, but can help out a bit

2. write a few unit tests and experiment with what the api does and whether it meets your needs. Contact is a pretty deep object and we've moved away from retrieving ALL information about a contact in one call (contribution, membership, participant etc). Not sure what information you are looking to extract from it, but would be good to confirm we do retrieve that information

lobo


lobo

u should be able to extend the REST.php function to include the group api also

ideally we should tweak the whole protocol and automatically call a function by creating a string like civicrm_OBJNAME_OPERATION and following that convention, rather than a switch statement. All functions are supposed to take one parameter (an array) and hence this should be relatively easy

lobo