What is a Sample API Request and Response

What is a Sample API Request and Response

This FAQ provides a sample API request and response to help you understand how to interact with Enact's system programmatically.

Sample Request:

METHOD: POST

URL: https://apitest.enact-systems.com/v2/lead/

Request Headers:

x-api-key: <NIMAIA API KEY> - platform to platform authentication key (Will be provided by Enact)


Request Body:

{
    "project_name": "Test API Project",
    "type": "R",
    "first_name": "Test",
    "last_name": "API",
    "email": "test@test.com",
    "phone": "(123) 123-1231",
    "account_id": "<account_id>", - unique client id -  specific to a customer account (it will be provided by Enact for each customer account)
    "address": "870 Peralta Ave, Berkeley, CA 94707, USA",
    "annual_electric_bill": "4000",
    "city":"Berkeley",
    "country":"USA",
    "project_owner_email": "someone@xyz.com",
    "project_owner_first_name": "John",
    "project_owner_last_name": "Doe",
    "state": "CA",
    "zip_code": "94707",
    "latitude": "37.89158467678897",
    "longitude": "-122.28592338361581"
}

Response:

{
    "message": "Project added successfully",
    "data": {
        "crn": "XXX-Y9C-WR8",
        "account_id": "<account_id>",
        "first_name": "Test",
        "last_name": "API",
        "address": "870 Peralta Ave, Berkeley, CA 94707, USA",
        "project_name": "Test API Project",
        "type": "R",
        "latitude": "37.89158467678897",
        "longitude": "-122.28592338361581",
        "city":"Berkeley",
        "state": "CA",
        "zip_code": "94707",
        "country": "USA",
        "email": "test@test.com",
        "phone": "(123) 123-1231",
        "project_owner_email": "someone@xyz.com",
        "project_owner_first_name": "John",
        "project_owner_last_name": "Doe",
        "source": "<account id>",
        "create_ts": "1743431183894"
    }
}

    • Related Articles

    • How is the Enact API integration priced?

      Enact API is an enterprise level agreement. For API discussions, Enact need to partner and understand the planned volume of projects, users, designs that will be typically done by the Installer over the course of a year. Contact Us for initiating a ...

    • Integrating with the Enact API: A Comprehensive Guide

      Integrating with the Enact API enables seamless interaction with Enact's suite of services, facilitating efficient data management and operational workflows. This guide provides an overview of key integration aspects, including creating leads, ...

    • Do I see individual users in Enact when the API is integrated?

      The Enact API integration is an API-to-API connection, meaning it doesn’t involve individual user accounts. All designs and data are created and managed under the main admin user, not separate user profiles

    • What does the Enact interface look like when accessed via API integration?

      When using the Enact API integration, the platform operates in a streamlined mode. There is no top navigation header, no project settings, and no logoff buttons—since it’s an API-to-API connection managed under a single admin account, not intended ...

    • How are administrative settings managed in Enact when using API integration?

      Since API integration does not create individual user accounts in Enact, all administrative settings are managed by the admin of the account. The admin must log in to the Enact application through the standard user interface to make changes. This ...