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 |
|---|
To do some actions with CRM data you can use CRM API. Now we have authorization in API. For access in API you need:
- apiKey
(Set in CRM Administration panel in Access inlay.)
- userName
(Login of JIRA's user, which will perform all actions)
As now all actions will be performed under the JIRA's user, he owe to have all rights for access to methods.
| For access to: | A user owe to have rights: | Function properties: |
|---|---|---|
| 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 |
How now owe to look method's calls :
1.
...
Calls examples.
Start synchronization:
http://
...
2.
Register organization "Adobe" to contact "Ted Johnson":
...
http://
...
3.
...
Receive organization with ID=15 and contact with ID=6:
http://
...
...
...
http://
...
...
Company Name&clients-org_www=test.com&tableName=CLIENTS&view-clients-org_industry=Consulting&view-clients-org_sla=SLA-1
...
Free
Value: | Need to replace on: |
|---|---|
${apiKey} | key's value (adjusted in Plugin administration panel) |
${userName} | JIRA user's login |
Here is an examples of a new method's calls.
1.
...
Receive all organizations:
http://
...
YOURDOMAIN/plugins/servlet/crm/api?apiKey=${apiKey}&userName=${userName}&command=getcompanies
2.
...
Receive all contacts:
http://
...
YOURDOMAIN/plugins/servlet/crm/api?apiKey=${apiKey}&userName=${userName}&command=getcontacts
3.
...
Receive organization with ID=2:
http://
...
YOURDOMAIN/plugins/servlet/crm/api?apiKey=${apiKey}&userName=${userName}&command=getcompanybyname&companyId=2
4.
...
Receive organization with name "Teamlead":
http://
...
YOURDOMAIN/plugins/servlet/crm/api?apiKey=${apiKey}&userName=${userName}&command=getcompanybyname&companyName=
...
5.
...
Receive contact with ID=2:
http://
...
YOURDOMAIN/plugins/servlet/crm/api?apiKey=${apiKey}&userName=${userName}&command=getcontactbyname&contactId=2
6.
...
Receive contact with name "Vladimir Putin":
http://
...
YOURDOMAIN/plugins/servlet/crm/api?apiKey=${apiKey}&userName=${userName}&command=getcontactbyname&contactName=
...
where:
${apiKey} - key's title${userName} - JIRA user's login