Agile CRM Integration
SM_IntegrationIntroduction_OnlyEN
You can integrate third-party systems with Service Manager in many ways. The method you select will depend on business requirements, architectural and security constraints as well as the characteristics specific to each third-party application or service.
This document describes an integration process that has already been implemented in a customer context.
To find out more about this integration (e.g. scripts to be used), please do not hesitate to contact your EasyVista contact, or your service provider and integrator.
Integration Summary
This integration is used to retrieve all available information from your Agile CRM domain using the Agile CRM REST API (GET method).
example Retrieve and display lists of contacts, deals, notes, tasks, events, campaigns and track/milestones in an Service Apps app
| Integration Data Feed (direction) | Authentication Type | Integration Connector Options | ||
|---|---|---|---|---|
|
|
|
REST data source |
Basic Access Authentication (used with a Personal API Key as Password)SaaS Version of Third-Party Product |
On-premise Version of Third-Party Product |
|---|---|
|
|
API detailed description
| Item | Comments |
|---|---|
| About the software and company |
Agile CRM offers contact management, marketing automation, telephony, analytics, web engagement, real-time alerts and social suite. Track, nurture, and sell like a pro. |
| Information about the REST API |
Date on which the information was retrieved from the software company's website: July 2015 Last known REST API name/version/date: No API Version |
| Main useful links to software company information about REST | |
| Format and sample of API resources/endpoints |
https://{subdomain}.agilecrm.com/dev/api Notes:
|
| API assets |
N/A |
| API recommendations (limitations, advice, tips) |
|
| Comments | No API versioning |
Step-by-step integration process
Agile CRM can be integrated with Service Apps in 4 easy steps:
- Step 1: Check the list of prerequisites
- Step 2: Start the process for creating the REST data source
- Step 3: Authenticate to Agile CRM
- Step 4: Create a query string using Agile CRM documentation
Step 1: Check the list of prerequisites
- This documentation assumes that you already have an Agile CRM domain.
- You need an Agile CRM user account to make API requests.
- You must be an administrator to be able to access the Agile CRM Admin interface and view or reset a Personal API Key.
- You need to use an API Key.
See the procedureHow to enable the Agile CRM Personal API Key To find out more, see the Agile CRM REST API Authentication1. Log in to your Agile CRM portal (with an Admin account).
2. Click on your account name, side to your profile picture on the top right corner of your portal.
3. Go to Admin Settings.
4. Your API key will be available in the API & Analytics section, under REST API.
5. You can click on [ RESET ] to get a new Personal API Key.
Step 2: Start the process for creating the REST data source
For details about the creation, see the wiki page REST data source
- Click
in the Objects pane. - Open the Online category and select the REST data source
. - Name the data source.
example Agile CRM_List of Contacts
Step 3: Authenticate to Agile CRM
Authenticate to Agile CRM with Basic Access Authentication (using a Personal API Key)
- Select the type of authentication: Authentication Type = Basic.
- Click
next to the Basic Authentication Parameters field. - Enter the User Name. Enter the Password.
- The user name is the email address of the Agile CRM account/login you want to use for this data source.
- The password is the token you obtained by selecting Admin settings in the profile of an Admin account.
- Once you validate, the *** symbols will appear in the field.
Step 4: Create a query string using Agile CRM documentation
See the Agile CRM API documentation (Endpoints)
See Examples of use cases
- Create a query string as a data source, i.e. a resource to access, in the URL field.
example You want to create a data source that will retrieve a list of all contacts ==> Enter the following text in the URL field. Note: Replace {subdomain} with the name of your Agile CRM domain.
https://{subdomain}.agilecrm.com/dev/contacts
Best Practice
See Best Practice for the REST data source
- You must not share the Personal API token. You must keep this token and all information on credentials secure.
Samples of most relevant use cases and resources
Notes:
- Replace {subdomain} in the URI with your subdomain name provided by Agile CRM.
Method: GET
| Use Case | Sample Endpoint | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Retrieve list of all contacts |
|
||||||||
| Retrieve list of all companies |
|
||||||||
| Retrieve list of all opportunities |
| ||||||||
| Retrieve list of all tasks |
| ||||||||
| Retrieve list of all tracks |
| ||||||||
| Retrieve list of all campaigns |
|
SAS_IntegrationRESTAboutTheUse_OnlyEN
About the use of the software companies API REST
- Numerous software companies limit the access to the API REST of their software, generally by basing itself on a number of calls by hour/day/month.
- Only specific editions of their software can be eligible in the use of the API REST (with or without additional cost).
- Some software companies set up plans, e.g., Classic, Professional, Enterprise, for which the number of possible calls to the REST API or even to specific resources (i.e. endpoints) can be more or less numerous.