Thanks to visit codestin.com
Credit goes to www.scribd.com

Scribd
Upload
4 views7 pages

IGS API Documentation

The IGS API documentation outlines the processes for creating opportunities, customers, and systems, as well as updating utilities and generating quotes. It provides specific HTTP methods, endpoint URLs, headers, and body structures required for each operation. Additionally, it includes steps for sending credit inquiries and assigning pricing to opportunities.

Uploaded by

azadjoomdev
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
4 views7 pages

IGS API Documentation

The IGS API documentation outlines the processes for creating opportunities, customers, and systems, as well as updating utilities and generating quotes. It provides specific HTTP methods, endpoint URLs, headers, and body structures required for each operation. Additionally, it includes steps for sending credit inquiries and assigning pricing to opportunities.

Uploaded by

azadjoomdev
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 7

IGS API Documentation

//Normal System Creation Process


#1. Create Opportunity
 Method: POST
 Endpoint URL:
https://partnerintegration.igs.com/solarcoreservices/api/v2/opportunity
 Headers: Content-Type: application/json
 Body:

"addressLine1": "2 Central Dr W, Briarcliff Manor, NY 10510",


"addressLine2": "",
"city": "Briarcliff Manor",
"state": "NY",
"zipCode": "10510"
}

#2. Create Customer


 Method: POST
 Endpoint URL: https://partnerintegration.igs.com/solarcoreservices/api/v2/customer
 Headers: Content-Type: application/json
 Body:

{
"partnerSystemNumber": "{{opportunity_id}}",
"firstName": Chetan",
"middleName": "",
"lastName": “Madaan",
"phoneNumber": “(778) 400-6968”,
"emailAddress": “[email protected]”
}

#3. Sales Agent Assign


 Method: POST
 Endpoint URL:
https://partnerintegration.igs.com/solarcoreservices/api/v2/opportunity/
{{opportunity_id}}/salesAgent/{{salesAgentId}}
 Headers: Content-Type: application/json
 Body:None

#4. Set Utility on Opportunity


 Method: PUT
 Endpoint URL:
https://partnerintegration.igs.com/solarcoreservices/api/v2/opportunity/
{{opportunity_id /utility/NY%20NatGrid
 Headers: Content-Type: application/json
 Body: None

#5. Create System


 Method: POST
 Endpoint URL: https://partnerintegration.igs.com/solarcoreservices/api/v2/system/
{{opportunity_id}}
 Headers: Content-Type: application/json
 Body:

{
"meterComponentKey": "d4308173-a205-4250-a5c6-7efc618a3f23",
"rackComponentKey": "b41ed474-8fa5-4bc9-8dae-6c1e7996b4a9",
"moduleComponentKey": "c824c667-dcf0-4234-bb37-6566ef5eef7f",
"arrayData": [{
"inverterComponentKey": "1d823e0e-8028-4287-9ecd-5c10a755d7fc",
"roofId": 1,
"tilt": 0,
"orientation": 0,
"numberOfPanels": 12,
"annualProduction": 0,
"unshadedPercent": 100,
"efficiency": 84,
"tof": 84
}, {
"inverterComponentKey": "1d823e0e-8028-4287-9ecd-5c10a755d7fc",
"roofId": 2,
"tilt": 0,
"orientation": 0,
"numberOfPanels": 12,
"annualProduction": 0,
"unshadedPercent": 100,
"efficiency": 84,
"tof": 84
}],
"isLineTrenchingRequired": true,
"shadeReportName": "Aurora"
}

//System update Process


#1. Update Utility on Opportunity
 Method: PUT
 Endpoint URL:
https://partnerintegration.igs.com/solarcoreservices/api/v2/opportunity/
{{opportunity_id /utility/NY%20NatGrid
 Headers: Content-Type: application/json
 Body: None

#2. Update System


 Method: PUT
 Endpoint URL: https://partnerintegration.igs.com/solarcoreservices/api/v2/system/
{{opportunity_id}}
 Headers: Content-Type: application/json
 Body:

{
"meterComponentKey": "d4308173-a205-4250-a5c6-7efc618a3f23",
"rackComponentKey": "b41ed474-8fa5-4bc9-8dae-6c1e7996b4a9",
"moduleComponentKey": "c824c667-dcf0-4234-bb37-6566ef5eef7f",
"arrayData": [{
"inverterComponentKey": "1d823e0e-8028-4287-9ecd-5c10a755d7fc",
"roofId": 1,
"tilt": 0,
"orientation": 0,
"numberOfPanels": 12,
"annualProduction": 0,
"unshadedPercent": 100,
"efficiency": 84,
"tof": 84
}, {
"inverterComponentKey": "1d823e0e-8028-4287-9ecd-5c10a755d7fc",
"roofId": 2,
"tilt": 0,
"orientation": 0,
"numberOfPanels": 12,
"annualProduction": 0,
"unshadedPercent": 100,
"efficiency": 84,
"tof": 84
}],
"isLineTrenchingRequired": true,
"shadeReportName": "Aurora"
}

//Quote Generation Process


#1. Disqualify Quote
 Method: PUT
 Endpoint URL:
https://partnerintegration.igs.com/solarcoreservices/api/v2/opportunity/
{{opportunity_id}}/quotes/{{quote_id}}/disqualify
 Headers: Content-Type: application/json
 Body: None

#2. QuotesGenerate
 Method: POST
 Endpoint URL:
https://partnerintegration.igs.com/solarcoreservices/api/v2/opportunity/
{{opportunity_id}}/quote
 Headers: Content-Type: application/json
 Body:
 {
"product":"LEASEPRODGUAR",
"escalator":0.029,
"annualProduction":15000,
"systemSize":17.20,
"rate":0.150,
"monthlyPayment":183.75
}

#3. estimatedUtilityDetails
 Method: POST
 Endpoint URL:
https://partnerintegration.igs.com/solarcoreservices/api/v2/opportunity/
{{opportunity_id}}/estimatedUtilityDetails
 Headers: Content-Type: application/json
 Body:

{
"currentAllInUtilityRate": 0.14,
"estimatedAnnualUsage": 14000
}

//Pricing generate process


 Method: POST
 Endpoint URL: https://partnerintegration.igs.com/solarcoreservices/api/v2/pricing/
sandbox
 Headers: Content-Type: application/json
 Body:

{
"product": "LEASEPRODGUAR",
"escalator":0.029,
"rate":"0.12",
"annualProduction": 12000,
"systemSize": 11,
"stateCode":"NJ",
"commonUtilityCode":"PSE&G"
}

//Send Credit Enquiry Process


#1. electronicConsent
 Method: POST
 Endpoint URL:
https://partnerintegration.igs.com/solarcoreservices/api/v2/customer/document/
electronicConsent?PartnerSystemNumber={{opportunity_id}}&noEmailReturnUrl=1
 Headers: Content-Type: application/json
 Body: None
#2. creditInquiry/invitation
 Method: POST
 Endpoint URL:
https://partnerintegration.igs.com/solarcoreservices/api/v2/customer/
creditInquiry/invitation?PartnerSystemNumber={{opportunity_id}}
 Headers: Content-Type: application/json
 Body: None

#3. Quote Assign Pricing with Opportunity


 Method: POST
 Endpoint URL:
https://partnerintegration.igs.com/solarcoreservices/api/v2/opportunity/
{{opportunity_id}}/quote
 Headers: Content-Type: application/json
 Body:

{
"product": "LEASEPRODGUAR",
"escalator": 0.029,
"annualProduction": 19024,
"systemSize": 19.32,
"rate": 0.14,
"monthlyPayment": 221.94
}

#4. estimatedUtilityDetails
 Method: POST
 Endpoint URL:
https://partnerintegration.igs.com/solarcoreservices/api/v2/opportunity/
{{opportunity_id}}/estimatedUtilityDetails
 Headers: Content-Type: application/json
 Body:

{
"currentAllInUtilityRate": 0.14,
"estimatedAnnualUsage": 14000
}

#5. Contract
 Method: POST
 Endpoint URL:
https://partnerintegration.igs.com/solarcoreservices/api/v2/customer/document/
contract?
PartnerSystemNumber={{opportunity_id}}&quoteIdentifier={{quote_id}}&noEmailRetu
rnUrl=1
 Headers: Content-Type: application/json
 Body: None

You might also like