CRM-2 API

From Opentaps Wiki
Revision as of 18:46, 31 July 2013 by Sichen (talk | contribs)
Jump to navigationJump to search

CRM-2 API is accessed via RESTful services using your authorization token key. All access to CRM-2 API follow this common pattern:

  • URL: RESTful URL of the CRM-2 resource
  • operation:
    • POST: creates new value
    • GET: get existing value(s)
    • PUT: update existing value
    • DELETE: delete existing value
  • clientDomain: name of your domain, ie xyz.com
  • authToken: your access token key, a very long alphanumeric string
  • parameters: key value pairs for your API operation

You can also use curl or a visual RESTful client to test the API. For example, 

$ curl -X POST 'http://localhost:8078/admin/activity-type' -d clientDomain=newdomain.com -d activityType="PINNED" 
-d authToken=b3748cd7b6ac92701bb1e7c409eac49afa377aff3bde5190a8445e62d46160da4daf7a1731fe9721
$ curl -X GET "http://localhost:8078/admin/activity-type?clientDomain=newdomain.com&authToken=b3748cd7b6ac92701bb1e7c409eac49afa377aff3bde5190a8445e62d46160da4daf7a1731fe9721"

will add a new email to be polled by crm-2

API available, grouped by section, are:

Retrieved from "https://docs.opentaps.org/docs/index.php?title=CRM-2_API&oldid=7371"