X-API-Key: gf_live_your_api_key_here

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 945
X-RateLimit-Reset: 2024-01-15T11:00:00Z

{
“applications”: [
{
“id”: “550e8400-e29b-41d4-a716-446655440000”,
“reference_number”: “FLOW-1704067200-ABC12”,
“application_type”: “solar_pv”,
“submission_method”: “paper”,
“applicant_name”: “John Smith”,
“applicant_email”: “john@example.com”,
“applicant_phone”: “07700900123”,
“applicant_company_name”: “Smith Solar Ltd”,
“site_address”: “123 Solar Street, London, SW1A 1AA”,
“postcode”: “SW1A 1AA”,
“mpan”: “1234567890123”,
“dno_name”: “UK Power Networks”,
“dno_code”: “UKPN”,
“installer_id”: “uuid-of-installer”,
“status”: “submitted”,
“payment_status”: “paid”,
“created_at”: “2024-01-15T10:30:00Z”,
“updated_at”: “2024-01-15T12:00:00Z”
}
],
“pagination”: {
“total”: 156,
“limit”: 50,
“offset”: 0,
“hasMore”: true
}
}

{
“applicationType”: “solar_pv”, // Required: solar_pv, solar_pv_and_battery, battery_storage_only, ev_charger, heat_pump, v2g_ev_charger
“submissionMethod”: “paper”, // Optional: paper (default) or ena_connect
“mpan”: “1234567890123”, // Required for document generation – determines DNO

“applicant”: { // Required
“firstName”: “John”, // Required
“lastName”: “Smith”, // Required
“email”: “john@example.com”, // Required
“phone”: “07700900123”,
“companyName”: “Smith Solar Ltd”,
“address”: “456 Business Park”,
“addressLine2”: “Suite 100”,
“city”: “Manchester”,
“postcode”: “M1 1AA”
},

“site”: { // Required
“street”: “123 Solar Street”, // Required
“addressLine2”: “”,
“city”: “London”, // Required for EV/HP applications
“postcode”: “SW1A 1AA”, // Required
“companyName”: “”, // If site is a business
“contactName”: “Jane Doe”, // Site contact (if different from applicant)
“contactEmail”: “jane@example.com”,
“contactPhone”: “07700900456”
},

“dno”: { // Optional – auto-detected from MPAN
“name”: “UK Power Networks”,
“code”: “UKPN”,
“email”: “connections@ukpn.co.uk”,
“reference”: “”
},

“installerId”: “uuid”, // Optional – reference to saved installer

“equipment”: {
“phase”: 1, // 1 for single phase, 3 for three phase
“fuseSize”: 80, // Main fuse size in amps
“inverters”: [
{
“manufacturer”: “SolarEdge”,
“model”: “SE5000H”,
“capacity”: 5.0, // kW
“enaCode”: “ENS123456”, // ENA registration number
“phase”: 1,
“existing”: false, // Is this an existing installation?
“remove”: false, // Is this being removed?
“panelWattage”: 400,
“panelCount”: 12,
“panelModel”: “JA Solar 400W”,
“battery”: {
“manufacturer”: “Tesla”,
“model”: “Powerwall 2”,
“capacity”: 13.5 // kWh
}
}
],
“evChargers”: [ // For ev_charger/v2g applications
{
“manufacturer”: “Ohme”,
“model”: “Home Pro”,
“capacity”: 7.4,
“enaCode”: “EVC123456”,
“type”: “AC” // AC, DC, or V2G
}
],
“heatPumps”: [ // For heat_pump applications
{
“manufacturer”: “Mitsubishi”,
“model”: “Ecodan PUZ”,
“capacity”: 8.5,
“enaCode”: “HP123456”
}
]
},

“installer”: { // Optional – inline installer details (alternative to installerId)
“companyName”: “Smith Solar Ltd”,
“contactName”: “John Smith”,
“email”: “john@smithsolar.com”,
“phone”: “07700900123”,
“address”: “456 Business Park”,
“city”: “Manchester”,
“postcode”: “M1 1AA”
}
}

{
“message”: “Application created”,
“application”: {
“id”: “550e8400-e29b-41d4-a716-446655440000”,
“referenceNumber”: “FLOW-1704067200-ABC12”,
“applicationType”: “solar_pv”,
“submissionMethod”: “paper”,
“status”: “draft”
}
}

{
“mpan”: “1234567890124”,
“applicant”: {
“firstName”: “Jane”,
“lastName”: “Smith”
},
“site”: {
“street”: “124 Updated Street”
},
“equipment”: {
“inverters”: […]
}
}

{
“message”: “Application submitted and documents generated”,
“status”: “submitted”,
“documentsGenerated”: 3,
“documents”: [
{ “name”: “G98-Application.pdf”, “type”: “G98”, “dno”: “UK Power Networks” },
{ “name”: “LOA.pdf”, “type”: “LOA”, “dno”: “” },
{ “name”: “SLD.pdf”, “type”: “SLD”, “dno”: “” }
]
}

{
“applications”: [
{ “applicationType”: “solar_pv”, “applicant”: {…}, “site”: {…}, … },
{ “applicationType”: “heat_pump”, “applicant”: {…}, “site”: {…}, … }
]
}

{
“currentStatus”: “submitted”,
“allowedTransitions”: [“documents_sent”, “pending_dno”, “withdrawn”],
“lastUpdated”: “2024-01-15T12:00:00Z”,
“documentsGeneratedAt”: “2024-01-15T10:30:00Z”,
“submissionErrors”: null,
“statusHistory”: [
{ “status”: “submitted”, “details”: {…}, “timestamp”: “2024-01-15T10:30:00Z” },
{ “status”: “draft”, “details”: null, “timestamp”: “2024-01-15T09:00:00Z” }
]
}

{
“status”: “documents_sent”,
“notes”: “Documents emailed to DNO”
}

{
“uploaded”: [
{
“id”: “doc-uuid”,
“name”: “cutout_photo.jpg”,
“type”: “cutout_image”,
“size”: 245760,
“mimeType”: “image/jpeg”,
“uploadedAt”: “2024-01-15T11:00:00Z”
}
],
“generated”: [
{
“id”: “gen-doc-uuid”,
“name”: “G98-Application.pdf”,
“type”: “generated”,
“dno”: “UK Power Networks”,
“path”: “uploads/applications/app-id/g98.pdf”
}
]
}

{
“documentType”: “mcs_certificate”,
“description”: “Please provide your MCS certificate for this installation”,
“deadline”: “2024-01-20T23:59:59Z”
}

{
“status”: “approved”, // pending, uploaded, approved, rejected
“rejectionReason”: “Document expired”
}

{
“companyName”: “Smith Solar Ltd”, // Required
“contactName”: “John Smith”,
“email”: “john@smithsolar.com”,
“phone”: “07700900123”,
“address”: “456 Business Park”,
“city”: “Manchester”,
“postcode”: “M1 1AA”,
“mcsNumber”: “MCS123456”
}

{
“error”: “Validation failed”,
“message”: “MPAN must be 13 digits”,
“validTypes”: [“solar_pv”, “heat_pump”, …] // Additional context when relevant
}

# List applications
curl -X GET “https://app.renewablehelp.co.uk/api/v1/applications?status=draft&limit=10” \
-H “X-API-Key: gf_live_your_api_key”

# Create application
curl -X POST “https://app.renewablehelp.co.uk/api/v1/applications” \
-H “X-API-Key: gf_live_your_api_key” \
-H “Content-Type: application/json” \
-d ‘{
“applicationType”: “solar_pv”,
“mpan”: “1234567890123”,
“applicant”: {
“firstName”: “John”,
“lastName”: “Smith”,
“email”: “john@example.com”
},
“site”: {
“street”: “123 Solar Street”,
“city”: “London”,
“postcode”: “SW1A 1AA”
},
“equipment”: {
“inverters”: [{
“manufacturer”: “SolarEdge”,
“model”: “SE5000H”,
“capacity”: 5.0
}]
}
}’

# Submit application
curl -X POST “https://app.renewablehelp.co.uk/api/v1/applications/{id}/submit” \
-H “X-API-Key: gf_live_your_api_key”

# Upload document
curl -X POST “https://app.renewablehelp.co.uk/api/v1/applications/{id}/documents” \
-H “X-API-Key: gf_live_your_api_key” \
-F “file=@/path/to/cutout.jpg” \
-F “type=cutout_image”

# Download document
curl -X GET “https://app.renewablehelp.co.uk/api/v1/applications/{id}/documents/{docId}” \
-H “X-API-Key: gf_live_your_api_key” \
–output document.pdf

const axios = require(‘axios’);
const FormData = require(‘form-data’);
const fs = require(‘fs’);

const API_KEY = ‘gf_live_your_api_key’;
const BASE_URL = ‘https://app.renewablehelp.co.uk/api/v1’;

const api = axios.create({
baseURL: BASE_URL,
headers: { ‘X-API-Key’: API_KEY }
});

// List applications
async function listApplications(filters = {}) {
const response = await api.get(‘/applications’, { params: filters });
return response.data;
}

// Create application
async function createApplication(data) {
const response = await api.post(‘/applications’, data);
return response.data;
}

// Submit application
async function submitApplication(id) {
const response = await api.post(`/applications/${id}/submit`);
return response.data;
}

// Upload document
async function uploadDocument(appId, filePath, type) {
const form = new FormData();
form.append(‘file’, fs.createReadStream(filePath));
form.append(‘type’, type);

const response = await api.post(`/applications/${appId}/documents`, form, {
headers: form.getHeaders()
});
return response.data;
}

// Example usage
async function main() {
// Create and submit an application
const app = await createApplication({
applicationType: ‘solar_pv’,
mpan: ‘1234567890123’,
applicant: { firstName: ‘John’, lastName: ‘Smith’, email: ‘john@example.com’ },
site: { street: ‘123 Solar Street’, city: ‘London’, postcode: ‘SW1A 1AA’ },
equipment: { inverters: [{ manufacturer: ‘SolarEdge’, model: ‘SE5000H’, capacity: 5.0 }] }
});

console.log(‘Created:’, app.application.referenceNumber);

// Submit to generate documents
const result = await submitApplication(app.application.id);
console.log(‘Documents generated:’, result.documentsGenerated);
}

main().catch(console.error);

import requests

API_KEY = ‘gf_live_your_api_key’
BASE_URL = ‘https://app.renewablehelp.co.uk/api/v1’

headers = {
‘X-API-Key’: API_KEY,
‘Content-Type’: ‘application/json’
}

def list_applications(**filters):
response = requests.get(f'{BASE_URL}/applications’, headers=headers, params=filters)
response.raise_for_status()
return response.json()

def create_application(data):
response = requests.post(f'{BASE_URL}/applications’, headers=headers, json=data)
response.raise_for_status()
return response.json()

def submit_application(app_id):
response = requests.post(f'{BASE_URL}/applications/{app_id}/submit’, headers=headers)
response.raise_for_status()
return response.json()

def upload_document(app_id, file_path, doc_type):
with open(file_path, ‘rb’) as f:
files = {‘file’: f}
data = {‘type’: doc_type}
response = requests.post(
f'{BASE_URL}/applications/{app_id}/documents’,
headers={‘X-API-Key’: API_KEY},
files=files,
data=data
)
response.raise_for_status()
return response.json()

# Example usage
if __name__ == ‘__main__’:
app = create_application({
‘applicationType’: ‘solar_pv’,
‘mpan’: ‘1234567890123’,
‘applicant’: {‘firstName’: ‘John’, ‘lastName’: ‘Smith’, ’email’: ‘john@example.com’},
‘site’: {‘street’: ‘123 Solar Street’, ‘city’: ‘London’, ‘postcode’: ‘SW1A 1AA’},
‘equipment’: {‘inverters’: [{‘manufacturer’: ‘SolarEdge’, ‘model’: ‘SE5000H’, ‘capacity’: 5.0}]}
})
print(f”Created: {app[‘application’][‘referenceNumber’]}”)

result = submit_application(app[‘application’][‘id’])
print(f”Documents generated: {result[‘documentsGenerated’]}”)

<?php

$apiKey = ‘gf_live_your_api_key’;
$baseUrl = ‘https://app.renewablehelp.co.uk/api/v1’;

function apiRequest($endpoint, $method = ‘GET’, $data = null) {
global $apiKey, $baseUrl;

$ch = curl_init();
$url = $baseUrl . $endpoint;

$headers = [“X-API-Key: $apiKey”];

if ($method === ‘POST’ || $method === ‘PUT’) {
$headers[] = ‘Content-Type: application/json’;
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
}

if ($method === ‘POST’) curl_setopt($ch, CURLOPT_POST, true);
if ($method === ‘PUT’) curl_setopt($ch, CURLOPT_CUSTOMREQUEST, ‘PUT’);
if ($method === ‘DELETE’) curl_setopt($ch, CURLOPT_CUSTOMREQUEST, ‘DELETE’);

curl_setopt_array($ch, [
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => $headers
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

return [‘code’ => $httpCode, ‘data’ => json_decode($response, true)];
}

// List applications
$result = apiRequest(‘/applications?status=draft&limit=10’);
print_r($result[‘data’]);

// Create application
$app = apiRequest(‘/applications’, ‘POST’, [
‘applicationType’ => ‘solar_pv’,
‘mpan’ => ‘1234567890123’,
‘applicant’ => [‘firstName’ => ‘John’, ‘lastName’ => ‘Smith’, ’email’ => ‘john@example.com’],
‘site’ => [‘street’ => ‘123 Solar Street’, ‘city’ => ‘London’, ‘postcode’ => ‘SW1A 1AA’],
‘equipment’ => [‘inverters’ => [[‘manufacturer’ => ‘SolarEdge’, ‘model’ => ‘SE5000H’, ‘capacity’ => 5.0]]]
]);

echo “Created: ” . $app[‘data’][‘application’][‘referenceNumber’] . “\n”;

// Submit
$appId = $app[‘data’][‘application’][‘id’];
$result = apiRequest(“/applications/$appId/submit”, ‘POST’);
echo “Documents generated: ” . $result[‘data’][‘documentsGenerated’] . “\n”;