LeadSquared Developer Centre

ON THIS PAGE

Getting Started with LeadSquared Connectors


To develop your own connector on LeadSquared, you’ll need access to –

  1. Two LeadSquared accounts with an Administrator user role and API access.
    • An account on the staging environment.
    • An account on the live environment.
    • If you don’t have an account, contact sales@leadsquared.com.
  2. Two Marketplace Development Portal accounts.
    • An account on the staging environment.
    • An account on the live environment. Access to the live environment is given only once a connector is tested and reviewed on staging.
    • To get access, contact appsmarketplace@leadsquared.com.

 

Workflow

Connectors are first developed and tested on the staging environment. After being reviewed and approved they can be pushed to production. On both environments, connectors progress through the following statuses –

CMP workflow

Status Description
Draft Default status when creating a connector.
Published Connector is published on the Apps Marketplace but visible to only your organization.
In Review Connector is pending review from the LeadSquared team.
Live Connector is published on the Apps Marketplace and visible to all organizations.
Hidden The connector is hidden from the Apps Marketplace by the LeadSquared team.

 

Staging Phase

  1. First, build your connector on the staging environment. The default status is ‘Draft’.
  2. Next, ‘Publish’ the connector. Once published it will be available on the LeadSquared Apps Marketplace on staging where you can test it. At this stage, the connector will only be available to your organization only.
  3. Once tested, submit it for review. We review your connector for compliance with our developer guidelines and security policies.
  4. Post review, the connector is made ‘Live’ on the LeadSquared Apps Marketplace on staging. The connector will now be available to all organizations.
  5. LeadSquared may change the status of your connector from ‘Live’ to ‘Hidden’ if required.

 

Live Phase

  1. After your connector is built, tested, and reviewed on staging, export the connector from the staging Marketplace Development Portal.
  2. Access your Marketplace Development Portal live account and import the connector.
  3. Make the changes necessary to run the connector on the live environment (use live APIs, URLs, etc.). When you’re done, change the status from ‘Draft’ to ‘Published’.
  4. Once published, the connector will be available to test on the live LeadSquared Apps Marketplace. Note that the connector will only be visible to your organization.
  5. Once tested, submit it for review. We review your connector for compliance with our developer guidelines and security policies.
  6. Post review, the connector is made ‘Live’ on the live LeadSquared Apps Marketplace. The connector will now be available to all organizations.
  7. LeadSquared may change the status of your connector from ‘Live’ to ‘Hidden’ if required.

 

API

Your API URLs will differ on staging and live environments. Be sure to use staging APIs while building a connector on the staging Marketplace Development Portal, and live APIs for the live instance.

Region Staging Production/Live
India https://api-in21.lsq-staging.com/v2/ https://api-in21.leadsquared.com/v2/
USA https://api-us11.lsq-staging.com/v2/ https://api-us11.leadsquared.com/v2/
Singapore https://api.lsq-staging.com/v2/ https://api.leadsquared.com/v2/
Ireland https://api-ir31.lsq-staging.com/v2/ https://api-ir31.leadsquared.com/v2/
Jakarta NA https://api-id51.leadsquared.com/v2/

 

Next Steps

Once you have access to all the necessary accounts and permissions, it’s time to Create your first connector.

On this page

© 2022 by MarketXpander Services Pvt Ltd. All Rights Reserved.