...
For access to API you need to specify the API Key (password) in the Administration/Plugins/CRM/AccessIntegrations:
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 |
addcontact | Add contact | Add contacts |
setcontact | Add |
exising contact to company | 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 |
searchentities | Search CRM objects by parameters | Search CRM objects by parameters |
editcontact | Edit contacts |
Ability to pass value parameters to the api methods by field codes or by field names | ||
editcompany | Edit companies | Ability to pass value parameters to the api methods by field codes or by field names |
updateOrCreateEntity | Add / Edit Objects | Example:
tableName - record type crm_param_1 - name of the first field crm_param_1_value - value of the first field Also, you can set the id for the existing record. | ||
transactionsList | Search CRM transactions | Search CRM transactions by given parameters |
Calls examples
Start synchronization:
http:
//YOURDOMAIN/plugins/servlet/crm/api?apiKey=${apiKey}&userName=${userName}&command=sync
...
http:
//YOURDOMAIN/plugins/servlet/crm/api?apiKey=${apiKey}&userName=${userName}&command=setcontact&companyId=15&contactId=6
Add contact with the specified attributes.
http:
//YOURDOMAIN/
plugins/servlet/crm/api?command=addcontact&userName=${userName}&apiKey=${apiKey}&clients-contact_name=new contact&clients-contact_company=newCompany&view-clients-contact_company=newCompany&clients-contact_email=new@new.com
Add company with the specified attributes.
...
http:
//YOURDOMAIN/plugins/servlet/crm/api?command=searchEntities&crm_param_1=Company&crm_param_1_value=Teamlead&tableName=CONTACTS&userName=
${userName}&apiKey=${apiKey}
Edit contact:
http:
//YOURDOMAIN/plugins/servlet/crm/api?
command=editcontact&apiKey=${apiKey}&userName=${userName}&contactId=${contactId}&view-clients-contact_position=${position}&clients-contact_position=${position}&clients-contact_email=${email}&clients-contact_login=${userName}
Edit company:
http:
//YOURDOMAIN
/plugins/servlet/crm/api?command=editcompany&apiKey=${apiKey}&userName=${userName}&companyId=${companyId}&view-clients-clients_field_d1facd51-01e0-4a68-a4f3-4aa3641a590e=Development,Training&clients-clients_field_d1facd51-01e0-4a68-a4f3-4aa3641a590e=Development,Training
http:
//YOURDOMAIN
/plugins/servlet/crm/api?command=editcompany&apiKey=${apiKey}&userName=${userName}&companyId=${companyId}&clients-clients_field_d8927b73-09ba-4094-b281-af6738e4432d=testest
http://YOURDOMAIN/plugins/servlet/crm/api?command=editcompany&apiKey=${apiKey}&userName=${userName}&companyId=${companyId}&Сompany name=${companyName}
Search CRM transactions
http://YOURDOMAIN/plugins/servlet/crm/api?command=transactionslist&userName=${userName}&apiKey=${apiKey}&saleVal=${issuekey}
where:
${apiKey} - API Key (password) in the Administration/Plugins/CRM/Access
${userName} - JIRA user's login