Cellxpert Integration

To enable Cellxpert integration with Impact CRM you need to follow the below steps

Step 1 - Role Creation

Go to Settings>System>User Management>Roles

  1. Click on ‘New’

  2. Type name of the new role i.e. ‘Cellxpert role'

  3. In the permissions section tick on the ‘Cellxpert Reports’

  4. Save your changes

Step 2 - User Creation

Go to Settings>System>User Management>Users

  1. Click on ‘New’

  2. Type First name, Last name, email and password of the new user

  3. Click on Save

  4. Assign the role you have created on Step 1 to the user

  5. Save your changes

Note: Make sure that you verify the email sent by the system before the 7 days expiration period

Step 3 - Create an API key

Go to Settings>System>User Management>Api Keys

  1. Click on ‘New’

  2. Type the name of the API key i.e. ‘Cellxpert API key’

  3. Add an expiration date for the API key

  4. Select the user that you have created in Step 2

  5. Save your changes

  6. From the column, ‘API key’ take the value that just generated

API key Usage:

1. Authenticating: Call the following endpoint:

Method:
    POST
Path:
    [domain]/api/v1/auth/login
Body:
    {"email": "USER_EMAIL", "password": "USER_PASSWORD", "rememberMe": true}
Headers:
    X-Api-Key (Provided Api Key)
    X-DOMAIN (Api key based domain)
    Content-Type application/json
Successful response:
    {"token": "TOKEN_RESPONSE"}


You'll receive a token required for calling the following endpoints

2. Leads: Call the following endpoint:(Depends on Cellxpert Reports permission) Returns details in regards to system leads

Method:
    GET
Path:
    [domain]/api/v1/cellxpert/leads
Headers:
    X-Api-Key (provided Api Key)
    X-DOMAIN (Api key based domain)
    X-Auth-Token (token from 1.)
Successful response:
    See leads.json file
Query parameters (i.e. filters)
    (*) registrationDateFrom (YYYY-MM-DD) : Lead registration date from filter
    (*) registrationDateTo (YYYY-MM-DD) : Lead registration date to filter
    (*) lastModifiedDateFrom (YYYY-MM-DD) : Lead last modified date from filter
    (*) lastModifiedDateTo (YYYY-MM-DD) : Lead last modified date to filter
    leadId (Optional): Filters by given lead id
    affId (Optional): Filters by given affiliate id
    page (Optional - Default = 1): Requested page for the results
    pageSize (Optional - Default = 1000): Requested page size for results
Example
    /api/v1/cellxpert/leads?registrationDateFrom=2017-04-01®istrationDateTo=2019-12-31&page=1&pageSize=500
(*) This endpoint requires either registration date OR last modified date to be present in the request

3. Registrations (converted leads i.e. customers): (Depends on Cellxpert Reports permission) Returns details in regards to converted leads, known as customers.

Method:
    GET
Path:
    [domain]/api/v1/cellxpert/registrations
Headers:
    X-Api-Key (provided Api Key)
    X-DOMAIN (Api key based domain)
    X-Auth-Token (token from 1.)
Successful response:
    See registrations.json file
Query parameters (i.e. filters)
    (*) registrationDateFrom (YYYY-MM-DD) : Customer registration date from filter
    (*) registrationDateTo (YYYY-MM-DD) : Customer registration date to filter
    (*) lastModifiedDateFrom (YYYY-MM-DD) : Customer last modified date from filter
    (*) lastModifiedDateTo (YYYY-MM-DD) : Customer last modified date to filter
    userId (Optional): Filters by given customer (user) id
    affId (Optional): Filters by given affiliate id
    page (Optional - Default = 1): Requested page for the results
    pageSize (Optional - Default = 1000): Requested page size for results
Example
    /api/v1/cellxpert/registrations?registrationDateFrom=2017-04-01®istrationDateTo=2019-12-31&page=1&pageSize=500
(*) This endpoint requires either registration date OR last modified date to be present in the request

4. Transactions: (Depends on Cellxpert Reports permission) Returns transaction details

Method:
    GET
Path:
    [domain]/api/v1/cellxpert/transactions
Headers:
    X-Api-Key (provided Api Key)
    X-DOMAIN (Api key based domain)
    X-Auth-Token (token from 1.)
Successful response:
    See transactions.json file
Query parameters (i.e. filters)
    (*) transactionDateFrom (YYYY-MM-DD) : Lead registration date from filter
    (*) transactionDateTo (YYYY-MM-DD) : Lead registration date to filter
    userId (Optional): Filters by given customer (user) id
    page (Optional - Default = 1): Requested page for the results
    pageSize (Optional - Default = 1000): Requested page size for results
Example
    /api/v1/cellxpert/transactions?transactionDateFrom=2017-04-01&transactionDateTo=2019-12-31&page=1&pageSize=500
(*) This endpoint requires transaction date to be present in the request

5. Available servers: (Depends on Cellxpert Reports permission) Returns available server ids (tags) of all platforms (mt4, mt5 etc.)

Method:
    GET
Path:
    [domain]/api/v1/cellxpert/servers
Headers:
    X-Api-Key (provided Api Key)
    X-DOMAIN (Api key based domain)
    X-Auth-Token (token from 1.)
Successful response:
    See servers.json file

6. Positions: (Depends on Cellxpert Reports permission) Returns closed position details. 

Method:
    GET
Path:
    [domain]/api/v1/cellxpert/positions
Headers:
    X-Api-Key (provided Api Key)
    X-DOMAIN (Api key based domain)
    X-Auth-Token (token from 1.)
Successful response:
    See positions.json file
Query parameters (i.e. filters)
    (*) positionCloseDateFrom (YYYY-MM-DD) : Position close date from filter
    (*) positionCloseDateTo (YYYY-MM-DD) : Position close date to filter
    (*) serverTag: Single server id as fetched from 4.
    userId (Optional): Filters by given customer (user) id
    page (Optional - Default = 1): Requested page for the results
    pageSize (Optional - Default = 1000): Requested page size for results
Example
    /api/v1/cellxpert/positions?positionCloseDateFrom=2017-04-01&positionCloseDateTo=2019-12-31&page=1&pageSize=500
(*) This endpoint requires serverTag and position close date to be present in the request

Important Notes:

  1. If the total number of results exceeds 1000 (or predefined page size) users need to call the required endpoint with the same parameters but the `page` size increased. The number of total pages can be identified by dividing total (number of records) by pageSize

  2. Registrations (customers)

    1. User additional ID - Comma-separated values of each customer trading account (platform-based) as:

      (login id, platform server, type (live/demo)) - Filtered only by live accounts
(12345, mt4, live)

  3. Transactions

    1. Only successful transactions are returned

    2. Product id if trade id is the trade-related identification (if any). If not found N/A is displayed

  4. Available servers response groups all servers by platform type

Related articles