Difference between revisions of "CRM-2 API"

From Opentaps Wiki
Jump to navigationJump to search
Line 35: Line 35:
* [[CRM-2 Contacts API]]
* [[CRM-2 Contacts API]]
* [[CRM-2 Activities API]]
* [[CRM-2 Activities API]]
* [[CRM-2 Tags API]]

Revision as of 21:46, 6 October 2014

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://crm-2-url/admin/activity-type' -d clientDomain=newdomain.com -d activityType="PINNED" 
-d authToken=<token>
$ curl -X GET "http://crm-2-url/admin/activity-type?clientDomain=newdomain.com
$ curl -X DELETE 'http://crm-2-url/admin/activity-type' -d clientDomain=newdomain.com -d activityType="PINNED" -d authToken=<token>

can be used to create, read, and delete data.

To update data, a PUT operation is used

$ curl -X PUT --data "clientDomain=xyz.com&mailUser=newemail@gmail.com&mailStoreProtocol="imaps"&

API available, grouped by section, are: