Portal API

LeadSquared’s Portal APIs give you the core functionality required to build your own portal for capturing leads (e.g., financial/education/medical application portals). These include APIs that facilitate lead registration, sign-in, sign-out and forgot/change/reset password functionality.

In conjunction with these APIs, you can export the custom forms in your LeadSquared application and use them to capture lead data directly from your portal to your account.

portal example

 

API Host

The API host is dependent on your account region.

Region API URL
India https://portalapi-in21.leadsquared.com/
U.S.A https://portalapi-us11.leadsquared.com/
Singapore https://portalapi.leadsquared.com/

Note: You must use the correct API host to make successful calls. If you use an incorrect host you’ll get a ‘401 Unauthorized’ error. The correct API host will be mentioned in the error message.

 

Authentication

Authentication for Portal APIs requires a public authentication key.

  1. To generate the public authentication key, call the Get Public Auth Key API and pass your LeadSquared Access Key and Secret Key in the query string.
  2. In all calls you make using Portal APIs, you must pass the public authentication key as an HTTP Header.
  3. The only exception is Change Password API which requires a private authentication key. This key gets generated when you successfully sign-in using the Sign-In API.

Note: You must be an administrator of your LeadSquared account. API calls will fail if you pass the access and secret keys associated with any other user role.

 

Forms and Processes

The LeadSquared Forms and Process designer lets you create dynamic forms and string together entire application processes. These forms can be embedded in your portal’s webpages so you can directly capture lead information to your LeadSquared account.

The first step is to export a published form to HTML.

manage forms export form html

You can then copy the form HTML and paste it in your webpage based on your customization requirements.

copy form HTML

Here’s an example of a LeadSquared form embedded in a sample education application portal –

sample lsq form export

 

List of APIs

Here’s the list of APIs that are currently available –