Difference between revisions of "CRM-2 API"
From Opentaps Wiki
Jump to navigationJump to searchm (Protected "CRM-2 API": Sysop page [edit=sysop:move=sysop]) |
|||
| Line 1: | Line 1: | ||
CRM-2 API is accessed via RESTful services using your authorization token key. All access to CRM-2 API follow this common pattern: | 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 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, | You can also use curl or a visual RESTful client to test the API. For example, | ||
| − | + | <pre> | |
| − | $ curl | + | $ curl POST --data "clientDomain=xyz.com&mailUser=newemail@gmail.com&mailStoreProtocol="imaps"& |
| − | + | mailHost="pop.googlemail.com"&mailPass="123456" | |
| + | &authToken=12345678901234567890abcdefghijklmnopqrstuvwxyz1234567890" | ||
| + | http://crm-2-url/admin/email-to-poll | ||
| + | </pre> | ||
| + | |||
| + | will add a new email to be polled by crm-2 | ||
API available, grouped by section, are: | API available, grouped by section, are: | ||
| − | + | * [[CRM-2 Administrative API]] | |
| − | + | * [[CRM-2 Contacts API]] | |
| − | + | * [[CRM-2 Activities API]] | |
Revision as of 21:48, 28 March 2013
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 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 POST --data "clientDomain=xyz.com&mailUser=newemail@gmail.com&mailStoreProtocol="imaps"& mailHost="pop.googlemail.com"&mailPass="123456" &authToken=12345678901234567890abcdefghijklmnopqrstuvwxyz1234567890" http://crm-2-url/admin/email-to-poll
will add a new email to be polled by crm-2
API available, grouped by section, are:
