Agile CRM Integration


About this integration
SAS_IntegrationRESTIntroduction_OnlyEN

You can integrate third-party systems with Product name - ev sas.png 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. You can use the REST, CSV, Online CSV data sources as well as the HTML Script widget.

This document describes a standard integration process with the REST data source that has already been implemented in a customer context. It provides only a few examples of HTTP queries for manipulating resources (i.e. endpoints) using the REST API in the third-party application. You can discover more about the possibilities of this API and consult the relevant documentation on the website of the third-party software company.

To find out more about this integration, please contact the Logo - EasyVista.png Consulting & Professional Services team, the Logo - EasyVista.png Support team, 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 documentation icon EN.png  Retrieve and display lists of contacts, deals, notes, tasks, events, campaigns and track/milestones in an Product name - ev sas.png app

Integration Data Feed (direction) Authentication Type Integration Connector Options

Product name - ev sas - big.png

Up arrow.png

Logo - Agile CRM.png

Check icon.png   Basic Access Authentication (used with a Personal API Key as Password)

REST data source   Apps - Datasource - JSON Online icon.png

SaaS Version of Third-Party Product

On-premise Version of Third-Party Product

Check icon.png

Not check icon.png

SAS_ConventionAPIRequests_OnlyEN

Convention for the API requests

Curly brackets { } indicate values you have to supply. 

In most of the cases, we draw your attention with:

  • in green and bold, the important and mandatory values to be replaced;
  • in green, certain important and/or optional values (often choice of parameters).

Example documentation icon EN.png  https://{subdomain}.agilecrm.com  ==> replace {subdomain} with the name of your Agile CRM domain

API detailed description

Item Comments
About the software and company

Logo - Agile CRM.png

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

Agile CRM Developers API

Agile CRM REST API Introduction (on GitHub)

Format and sample of API resources/endpoints

https://{subdomain}.agilecrm.com/dev/api

Notes:
  • When documenting a resource, Agile CRM uses curly brackets { } for identifiers.
  • Replace in the URI {subdomain} with your subdomain name provided by Agile CRM.
API assets

N/A

API recommendations (limitations, advice, tips)
  • API calls: No data available
  • Pagination: page_size = X (No default mentionned, No max indicated, samples indicate only 10, 20 or 25). Paging can be applied using the page_size and cursor query parameters. Count of the records (e.g. contacts or opportunities) will be in the first contact. Cursor for the next page will be in the last contact of the list. If there is no cursor, it means that it is the end of list.
Comments No API versioning

Step-by-step integration process

Agile CRM can be integrated with Product name - ev sas.png in 4 easy steps:


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.
    Open url.png See the procedure
    How to enable the Agile CRM Personal API Key

    Open url.png To find out more, see the Agile CRM REST API Authentication

    1. 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.

    Prerequisites - Get Personal API Key.png


Step 2: Start the process for creating the REST data source

  Open url.png  For details about the creation, see the wiki page REST data source

  • Click Apps - Add datasource icon.png in the Objects pane
  • Open the Online category and select the REST data source Apps - Datasource - JSON Online icon.png.
  • Name the data source.
             Example documentation icon EN.png  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 Apps - Edit icon.png next to the Basic Authentication Parameters field. 
  • Enter the User Name. Enter the Password.
             Basic Access Authentication.png
    • 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

        Open url.png  See the Agile CRM API documentation (Endpoints)
        Open url.png  See Examples of use cases

  • Create a query string as a data source, i.e. a resource to access, in the URL field.

Example documentation icon EN.png  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 big icon.pngBest Practice

       Open url.png  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

Authentication Type: Basic Access Authentication (Using Personal API Key)
Basic Authentication Parameters: User Name: {email_address}

Password: {Token}

URI: https://{subdomain}.agilecrm.com/dev/api/contacts?page_size=25
Selector:
Retrieve list of all companies

Authentication Type: Basic Access Authentication (Using Personal API Key)
Basic Authentication Parameters: User Name: {email_address}

Password: {Token}

URI: https://{subdomain}.agilecrm.com/dev/api/contacts/companies/list?page_size=25
Selector:
Retrieve list of all opportunities

Authentication Type: Basic Access Authentication (Using Personal API Key)
Basic Authentication Parameters: User Name: {email_address}

Password: {Token}

URI: https://{subdomain}.agilecrm.com/dev/api/opportunity?page_size=25
Selector:
Retrieve list of all tasks

Authentication Type: Basic Access Authentication (Using Personal API Key)
Basic Authentication Parameters: User Name: {email_address}

Password: {Token}

URI: https://{subdomain}.agilecrm.com/dev/api/tasks?page_size=25
Selector:
Retrieve list of all tracks

Authentication Type: Basic Access Authentication (Using Personal API Key)
Basic Authentication Parameters: User Name: {email_address}

Password: {Token}

URI: https://{subdomain}.agilecrm.com/dev/api/milestone/pipelines?page_size=25
Selector:
Retrieve list of all campaigns

Authentication Type: Basic Access Authentication (Using Personal API Key)
Basic Authentication Parameters: User Name: {email_address}

Password: {Token}

URI: https://{subdomain}.agilecrm.com/dev/api/workflows?page_size=25
Selector:
SAS_IntegrationRESTAboutTheUse_OnlyEN

About the use of the third-parties REST API

Please note that numerous software companies limit the access to the REST API of their software, generally by basing itself on a number of calls by hour/day/month.
Moreover, only specific editions of their software can be eligible in the use of the API REST (with or without additional cost).
Finally, some software companies set up plans (for example Classic, Professional, Enterprise, etc.) 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.

The possible cost of the use of the third-parties API by means of Product name - ev sas.png is not taken care by Logo - EasyVista.png.

Tags:
Last modified by Unknown User on 2017/04/24 15:21
Created by Administrator XWiki on 2016/07/01 10:24

Shortcuts

Recent Updates

Haven't been here in a while? Here's what changed recently:

-   Product name - ev itsm.png
-   Product name - ev sas.png

Interesting Content

How to Automate Integration
Add a Shortcut to an App
History
Quick Dashboard
Full text search - Stop Words

Powered by XWiki ©, EasyVista 2018