From Opentaps Wiki
Revision as of 21:48, 28 March 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, GET, PUT, DELETE
  • clientDomain: name of your domain, ie
  • 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 POST --data ""imaps"&

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

API available, grouped by section, are: