Usage of the API [code]

AUTOLOGIN Process Overview

The AUTOLOGIN process is designed to:

1. Receive form information via the POST method.
2. Register the lead into the CRM.
3. Register the user onto the platform.
4. Redirect the user with automatic login.

To follow up on the lead’s status, you can use the API (GET LEADS BY DATE or GET LEADS BY ID) to retrieve the status of all leads based on the source_id field obtained during onboarding.

Note:
The API and the AUTOLOGIN are two separate processes.

AUTOLOGIN Fields

The AUTOLOGIN process requires the following mandatory fields:

• username: For CRM and platform usage.
• password: For user authentication.
• email: Used as the username for login (login is email-based).
• source_id: For tracking the lead and user.
• name: Required for both CRM and platform use.

Available API Commands

Below are the available commands in the API and their expected responses. For this example, we’ll use a dummy token and a random command to illustrate the process.

Example: Listing All Available Customers

Let’s assume your new token is: jEheVytlAoFl7F8MqUQ7jAo2hOXASztXjEheVytlAoFl7F8MqUQ7jAo2hOXASztXjEheVytlAoFl7F8MqUQ7jAo2hOXASztX

To list all available customers using the API, execute the following cURL request:

Command Request

curl -H "authtoken: jEheVytlAoFl7F8MqUQ7jAo2hOXASztXjEheVytlAoFl7F8MqUQ7jAo2hOXASztX" https://mysite.com/api/customers

Response of Command Request

[
   {
      "stripe_id" : null,
      "active" : "1",
      "vat" : "1234567890",
      "address" : "Test Address",
      "billing_country" : "0",
      "phonenumber" : "1234567890",
      "registration_confirmed" : "1",
      "longitude" : null,
      "billing_city" : "",
      "state" : "Test State",
      "shipping_zip" : "",
      "billing_zip" : "",
      "city" : "Test City",
      "shipping_country" : "0",
      "billing_street" : "",
      "datecreated" : "2019-11-29 12:34:56",
      "company" : "Jk Technologies",
      "shipping_street" : "",
      "zip" : "123456",
      "billing_state" : "",
      "leadid" : null,
      "addedfrom" : "8",
      "userid" : "3",
      "default_language" : "english",
      "shipping_state" : "",
      "show_primary_contact" : "0",
      "country" : "102",
      "default_currency" : "3",
      "shipping_city" : "",
      "latitude" : null,
      "website" : "https://example.com"
   },
   {
      "website" : "https://example2.com",
      "latitude" : null,
      "default_currency" : "0",
      "shipping_city" : "London",
      "country" : "235",
      "show_primary_contact" : "0",
      "shipping_state" : "Greater London",
      "default_language" : "",
      "addedfrom" : "1",
      "userid" : "1",
      "leadid" : null,
      "billing_state" : "Greater London",
      "zip" : "WC1 ASW",
      "shipping_street" : "123 Road Street",
      "company" : "Sample Company LTD",
      "datecreated" : "2019-04-02 13:38:28",
      "billing_street" : "123 Road Street",
      "shipping_country" : "235",
      "city" : "London",
      "billing_zip" : "WC1 ASW",
      "shipping_zip" : "WC1 ASW",
      "longitude" : null,
      "registration_confirmed" : "1",
      "billing_city" : "London",
      "state" : "Greater London",
      "phonenumber" : "+44 210 7298299",
      "billing_country" : "235",
      "address" : "123 Road Street",
      "vat" : "123456789",
      "active" : "1",
      "stripe_id" : null
   }
]