| Table of Contents |
|---|
What for need CRM API
It need that external applications can programmatically add and receive data to CRM. To work with the API, you must configure the security key (password) and the rights of the user that will be connected.
Setting access to API
For access to API you need to specify the API Key (password) in the Administration/Plugins/CRM/Access:
Access rights to CRM objects
To receive data via API, you can use different users with different access rights. Access rights to the objects defined in the Administration/Plugins/CRM/Access:
Supported methods
| Method's name | User right | Description |
|---|---|---|
| getcompanybyname | CRM Main Menu | Return company by name or ID |
| getcontactbyname | CRM Main Menu | Return contact by name or ID |
| getcompanies | CRM Main Menu | Return all companies |
| getcontacts | CRM Main Menu | Return all contacts |
| sync | CRM Main Menu | Start synchronization of JIRA users |
| setcrmproperties | CRM Main Menu | Set custom field type "Crm Property" in issue |
| addcompany | Add companies | Add company |
| setcontact | Add contacts | Set company for contacts |
| adddictionaryvalue | Add the values to dictionaries | Add new value to a custom dictionary |
| removedictionaryvalue | Remove the values from dictionaries | Remove value from a custom dictionary |
| getContactEmail | Return contact's email from ContactsCustomField or ContactSelectCF |
Calls examples
Start synchronization:
http://YOURDOMAIN/plugins/servlet/crm/api?apiKey=${apiKey}&userName=${userName}&command=sync
...