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/AccessIntegrations:

Image RemovedImage Added

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:

Image RemovedImage Added

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

contacts

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

getContactEmail Return contact's email from ContactsCustomField or ContactSelectCF

...

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: Code Block /plugins/servlet/crm/api?command=updateOrCreateEntity&userName=&apiKey=&tableName=PRODUCTS&crm_param_1=Product%20Name&crm_param_1_value=Test&id=&crm_param_2=Price&crm_param_2_value=10&crm_param_3=Vendor&crm_param_3_value=Atlassian&crm_param_4=area&crm_param_4_value=area 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

...

http://YOURDOMAIN/plugins/servlet/crm/api?apiKey=${apiKey}&userName=${userName}&command=setcontact&companyName=Adobe&contactName=TedJohnson

Receive organization Add contact with ID=15 and contact 6 to organization with ID=615:

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.

...

Add value "Green" to the custom dictionary "Colors":

http://YOURDOMAIN/plugins/servlet/crm/api?command=adddictionaryvalue&userName=${userName}&apiKey=${apiKey}&dictionaryName=Colors&newvalue=Green

Remove value "Green" from the custom dictionary "Colors":

http://YOURDOMAIN/plugins/servlet/crm/api?command=removedictionaryvalue&userName=${userName}&apiKey=${apiKey}&dictionaryName=Colors&valuetoremove=Green

Search for all contacts of "Teamlead" organization:

http://YOURDOMAIN/plugins/servlet/crm/api?command=searchEntities&crm_param_1=Company&crm_param_1_value=Teamlead&tableName=CONTACTS&userName=${userName}&apiKey=${apiKey}

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}