CiviCRM Community Forums (archive)

Hi, I'd appreciate any help in figuring out how to properly access the REST interface.

CiviCRM version 4.0.4 with Drupal

When I visit my API explorer at civicrm/ajax/doc#explorer and generate a contact get REST query it looks like this:
.../sites/all/modules/civicrm//extern/rest.php?json=1&debug=1&version=3&entity=Contact&action=get&user={youruser}&pwd={password}&key={yourkey}

Unfortunately when I try to call this (where key is my site key found in civicrm.settings.php and user/pwd correspond to my Drupal user) I receive:
{"error_message":"Unknown function invocation.","is_error":1}

I've figured out that modify the query to the following is the only way to make it work (where api_key is what I generated and put into the civicrm_contacts table):
.../sites/all/modules/civicrm/extern/rest.php?q=civicrm/contact/get&key={yourkey}&json=1&api_key={your api_key}

Will successfully return the contact, but if I call this query without the api_key param the server will crash (making api_key the only option for authentication).

Unfortunately this is as far as I've been able to get.

If I try to do an update call such as this:
.../sites/all/modules/civicrm/extern/rest.php?q=civicrm/contact/update&id=26504&contact_type=Individual&do_not_email=1&key={yourkey}&json=1&api_key={your api_key}

I receive:
{"is_error":1,"error_message":"API permission check failed for civicrm_contact_update call; missing permission: add contacts."}

However, I've given the Drupal user corresponding to my api_key an administration role that has every single permission, including add contacts.

Am I going about this wrong?



Any tips would be appreciated, thanks!

Thanks for the reply, unfortunately I receive a very similar error using create:
{"is_error":1,"error_message":"API permission check failed for civicrm_contact_create call; missing permission: add contacts."}

Thanks for the reply, unfortunately I receive a very similar error using create:
{"is_error":1,"error_message":"API permission check failed for civicrm_contact_create call; missing permission: add contacts."}

The contact user having the api_key needs the proper permissions. Are you really really sure it's the case?

Hi,

Would be cool if you can publish the ruby code you are going to dev for that. As for the access rights, not sure, you will have to debug.

That's where the permission is tested (for the specific permissions)

/CRM/Core/DAO/.permissions.php

X+

P.S. You might want to upgrade or backport, the REST interface got some attention lately, might help

Hi,

Yeap, REST had a lot of various undocumented ways of working, or kind of working.

To clarify where I'm heading to:

/sites/all/modules/civicrm//extern/rest.php?json=1&version=3&entity=Contact&action=get&api_key={api_key}&key={yourkey}

ie params that are mandatory are the key, the api_key, the entity and the action. It should work that way in the latest version, if it doesn't 100% it's a bug.

I'm trying to update the doc/code accordingly. Please keep pointing where it isn't described like that (or better yet, wiki edit

It should work that way for a while. When we we will introduce oAuth later, we will likely put a config switch allowing to force oAuth or to keep that existing scheme.

Btw, if you have experience is good rest apis, please join the Api team mailing list.

X+

 http://[site.com]/sites/all/modules/civicrm//extern/rest.php?json=1&debug=1&version=3&entity=Contact&action=create&key=[site_key]&api_key=[admin_user_api_key]&contact_type=Individual&first_name=Test&last_name=Test

I successfully create a user, but the new user is assigned the API key of the admin user I am using.

Damn!

that's one of these cases where there is a conflict between fields used by the interface and those used by the entities.

Although it won't solve the conflict (we can't) we can at least consider that you can't update/create the api_key from the rest interface.

Would be create if you could unset it between the validation and the time it calls the underlying methods. Probably in there: /civicrm//extern/rest.php

Can you create an issue (patch welcome on the issue tracker?

X+